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 ( H5R_ref_t *ref_ptr, hid_t rapl_id, H5O_type_t *obj_type )
Parameters:
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_id | IN: Valid reference access property list identifier |
H5O_type_t * obj_type | OUT: 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 Value | Description |
|---|
H5O_TYPE_GROUP | Object is a group |
H5O_TYPE_DATASET | Object is a dataset |
H5O_TYPE_NAMED_DATATYPE | Object is a named datatype |
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.12.0 | C function was introduced in this release. |
--- Last Modified: July 10, 2020 | 09:01 AM
