Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  IDL Reference  >  I/O - HDF5  >  H5G_GET_COMMENT

H5G_GET_COMMENT

H5G_GET_COMMENT

The H5G_GET_COMMENT function retrieves a comment string from a specified object.

Syntax


Result = H5G_GET_COMMENT(Loc_id, Name)

Return Value


Returns a string containing the comment, or an empty string if no comment exists.

Arguments


Loc_id

An integer representing the identifier of the file or group.

Name

A string representing the name of the object for which to retrieve the comment.

Keywords


None

Version History


5.6

Introduced

See Also


H5G_GET_OBJINFO



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us