Retrieves the type of a reference
Procedure:
Signature:
H5R_type_t H5Rget_type ( const H5R_ref_t *ref_ptr )
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]; |
Description:
Given a reference, ref_ptr, H5R_GET_TYPE returns the type of the reference.
Valid returned reference types are:
| Reference Type | Description |
|---|
H5R_OBJECT2 | Object reference version 2 |
H5R_DATASET_REGION2 | Region reference version 2 |
H5R_ATTRIBUTE | Attribute reference |
Note that H5R_OBJECT1 and H5R_DATASET REGION1 can never be associated to an H5R_ref_t reference and can therefore never be returned through that function.
Returns:
Returns a valid reference type if successful; otherwise returns H5R_UNKNOWN.
Example:
History:
| Release | Change |
|---|
| 1.12.0 | C function introduced in this release. |
--- Last Modified: November 14, 2019 | 09:41 AM
