Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5G_GET_OBJTYPE_BY_IDX

Returns the type of an object specified by an index. 

This function is deprecated in favor of the function H5O_GET_INFO.

 

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 idxIN: Transient index identifying object.

Description:

H5Gget_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_GROUP0Object is a group.
 H5G_DATASET   1   Object is a dataset.
 H5G_TYPE2Object is a named datatype.
    H5G_LINK3Object is a symbolic link.
    H5G_UDLINK4Object is a user-defined link.

Returns:

Returns the type of the object if successful. Otherwise returns a negative value.

Example:

Coming soon!

 

History:
Release    C
1.6.0Function introduced in this release.
1.6.0The function return type changed from int to the enumerated type H5G_obj_t.
1.8.0Function deprecated in this release.

--- Last Modified: January 03, 2018 | 03:07 PM