Returns the type of an object specified by an index
Procedure:
H5G_GET_OBJTYPE_BY_IDX(loc_id, idx)
Signature:
int H5Gget_objtype_by_idx( hid_t loc_id, hsize_t idx )
Parameters:
hid_t loc_id | IN: Group or file identifier |
hsize_t idx | IN: Transient index identifying object |
Description:
H5G_GET_OBJTYPE_BY_IDX returns the type of the object specified by the index idx in the group loc_id.
The group is specified by a group identifier loc_id. If preferred, a file identifier may be passed in loc_id; that file's root group will be assumed.
idx is the transient index used to iterate through the objects in the group. This parameter is described in more detail in the discussion of H5G_GET_OBJNAME_BY_IDX.
The object type is returned as the function return value:
| | H5G_GROUP | 0 | Object is a group |
| | H5G_DATASET | 1 | Object is a dataset |
| | H5G_TYPE | 2 | Object is a named datatype |
| | H5G_LINK | 3 | Object is a symbolic link |
| | H5G_UDLINK | 4 | Object is a user-defined link |
Returns:
Returns the type of the object if successful. Otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.6.0 | Function introduced in this release. |
| 1.6.0 | The function return type changed from int to the enumerated type H5G_obj_t. |
| 1.8.0 | Function deprecated in this release. |
--- Last Modified: April 25, 2019 | 11:28 AM
