Last modified: 25 February 2016
Name: H5Rdereference2

Signature:
hid_t H5Rdereference2( hid_t obj_id, hid_t oapl_id, H5R_type_t ref_type, void *ref )

Purpose:
Opens the HDF5 object referenced.

Description:
Given a reference, ref, to an object or a region in an object, H5Rdereference2 opens that object and returns an identifier.

The parameter obj_id must be a valid identifier for the HDF5 file containing the referenced object or for any object in that HDF5 file.

The parameter oapl_id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group, dataset, or datatype property list.

The parameter ref_type specifies the reference type of the reference ref. ref_type may contain either of the following values:

The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function such as H5Oclose or H5Dclose for datasets.

Parameters:
hid_t obj_id IN: Valid identifier for the file containing the referenced object or any object in that file.
hid_t oapl_id IN: Valid object access property list identifier for a property list to be used with the referenced object.
H5R_type_t ref_type     IN: The reference type of ref.
void *ref IN: Reference to open.

Returns:
Returns identifier of referenced object if successful; otherwise returns a negative value.

Fortran90 Interface: h5rdereference_f

To dereference an object:

To dereference a region:

Fortran2003 Interface: h5rdereference_f

See Also:
Using Identifiers

History:
Release     Change
1.10.0 C function H5Rdereference2 introduced in this release.