Last modified: 4 March 2016
Name: H5Rdereference1

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

Purpose:
Opens the HDF5 object referenced.

Notice:
This function has been renamed from H5Rdereference and is deprecated in favor of the macro H5Rdereference or the function H5Rdereference2.

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

The parameter obj_id must be a valid identifier for an object in the HDF5 file containing the referenced object, including the file identifier.

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.
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 H5Rdereference renamed to H5Rdereference1 and deprecated in this release.
1.8.8 Fortran updated to Fortran2003.
1.8.0 C function introduced in this release.