Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]

H5G_GET_COMMENT


Syntax | Return Value | Arguments | Keywords | Version History | See Also

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 a null 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

Introduced 5.6

See Also

H5G_GET_OBJINFO


Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]