Last modified: 28 September 2011
Name: H5Rget_obj_type
Signature:
H5G_obj_t H5Rget_obj_type( hid_t loc_id, H5R_type_t ref_type, void *ref )

herr_t H5Rget_obj_type( hid_t loc_id, H5R_type_t ref_type, void *ref, H5O_type_t *obj_type )

Purpose:
Retrieves the type of object that an object reference points to.

Description:
H5Rget_obj_type is a macro that is mapped to either H5Rget_obj_type1 or H5Rget_obj_type2, 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, H5Rget_obj_type is mapped to the most recent version of the function, currently H5Rget_obj_type2. If the library and/or application is compiled for Release 1.6 emulation, H5Rget_obj_type will be mapped to H5Rget_obj_type1. 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 H5Rget_obj_type mapping

Global settings
No compatibility flag H5Rget_obj_type2 
Enable deprecated symbols H5Rget_obj_type2 
Disable deprecated symbols H5Rget_obj_type2 
Emulate Release 1.6 interface     H5Rget_obj_type1 

Function-level macros
H5Rget_obj_type_vers = 2 H5Rget_obj_type2
H5Rget_obj_type_vers = 1 H5Rget_obj_type1

Fortran90 Interface: h5rget_object_type_f

Fortran2003 Interface: h5rget_object_type_f

History:
Release     Change
1.8.8 Fortran updated to Fortran2003.
1.8.0 The C function H5Rget_obj_type renamed to H5Rget_obj_type1 and deprecated in this release.
The C macro H5Rget_obj_type and the C function H5Rget_obj_type2 introduced in this release.