Last modified: 3 March 2016
Name: H5Rdereference
Signature:
hid_t H5Rdereference( hid_t loc_id, H5R_type_t ref_type, void *ref )

hid_t H5Rdereference( hid_t loc_id, hid_t oapl_id, H5R_type_t ref_type, void *ref )

Purpose:
Opens the HDF5 object referenced.

Description:
H5Rdereference is a macro that is mapped to either H5Rdereference1 or H5Rdereference2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. Their use and mappings are fully described in “API Compatibility Macros in HDF5”; we urge you to read that document closely.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Rdereference is mapped to the most recent version of the function, currently H5Rdereference2. If the library and/or application is compiled for Release 1.6 or 1.8 emulation, H5Rdereference will be mapped to H5Rdereference1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility setting H5Rdereference mapping

Global settings
No compatibility flag H5Rdereference2 
Enable deprecated symbols H5Rdereference2 
Disable deprecated symbols H5Rdereference2 
Emulate Release 1.6 interface     H5Rdereference1 
Emulate Release 1.8 interface  H5Rdereference1 

Function-level macros
H5Rdereference_vers = 2 H5Rdereference2
H5Rdereference_vers = 1 H5Rdereference1

Fortran90 Interface: h5rdereference_f

To dereference an object:

To dereference a region:

Fortran2003 Interface: h5rdereference_f

History:
Release     Change
1.10.0 The C function H5Rdereference renamed to H5Rdereference1 and deprecated in this release.
The C macro H5Rdereference and the C function H5Rdereference2 introduced in this release.