Page tree

The license could not be verified: License Certificate has expired!

 

JAVA

FORTRAN

C++

C

 

Link

H5R_GET_OBJ_TYPE3

Retrieves the type of object that an object reference points to

Procedure:

H5R_GET_OBJ_TYPE3 (ref_ptr, rapl_id, obj_type)

Signature:

herr_t H5Rget_obj_type3 ( const H5R_ref_t *ref_ptr, hid_t rapl_id, H5O_type_t *obj_type )

Replace this text with the Fortran function signature

Parameters:
const H5R_ref_t * ref_ptr

IN: Pointer to reference to query
H5R_ref_t is defined in H5Rpublic.h as:   typedef unsigned char H5R_ref_t[H5R_REF_BUF_SIZE];

hid_t rapl_idIN: Valid reference access property list identifier
H5O_type_t * obj_typeOUT: Type of referenced object

Description:

Given a reference, ref_ptr, H5R_GET_OBJ_TYPE3 retrieves the type of the referenced object in obj_type.

The parameter rapl id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).

The referenced object type, or the type of the referenced object, is the type of the object that the reference points to. When the function completes successfully, it returns one of the following valid object type values (defined in H5Opublic.h):

Object Type ValueDescription
H5O_TYPE_GROUPObject is a group
H5O_TYPE_DATASETObject is a dataset
H5O_TYPE_NAMED_DATATYPEObject is a named datatype

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
ReleaseChange
1.12.0C function was introduced in this release.

--- Last Modified: October 21, 2019 | 01:28 PM