The H5G_GET_OBJINFO function retrieves information from a specified object.
Syntax
Result = H5G_GET_OBJINFO(Loc_id, Name [, /FOLLOW_LINK] )
Return Value
Returns a structure of the name H5F_STAT containing the following fields:
FILENO
This field contains two integers which, along with the OBJNO field, uniquely identify the object among all open HDF5 files.
OBJNO
This field contains two integers which, along with the FILENO field, uniquely identify the object among all open HDF5 files. If all four values in FILENO and OBJNO are the same between two objects, then these two objects are the same.
NLINK
The number of hard links to the object. If this field is zero, then the object is a symbolic link.
TYPE
A string representing the object type. Possible values are:
- ‘LINK’
- ‘GROUP’
- ‘DATASET’
- ‘TYPE’
- ‘UNKNOWN’
MTIME
The modification time for the object, in seconds since 1 January 1970.
Tip: You can convert the MTIME field from seconds to a date/time string using SYSTIME(0, mtime). See SYSTIME for more information.
LINKLEN
If the object is a symbolic link (and the FOLLOW_LINK keyword is not set), then this field will contain the length in characters of the link value. The link value itself may be retrieved using H5D_GET_LINKVAL.
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 information structure.
Keywords
FOLLOW_LINK
If Name is a symbolic link, then set this keyword to follow the symbolic link and retrieve information about the linked object. The default is to return information about the symbolic link itself.
Version History
See Also
H5G_GET_LINKVAL