H5Rget_obj_type(
hid_t loc_id,
H5R_type_t ref_type,
void *ref
)
H5Rget_obj_type(
hid_t loc_id,
H5R_type_t ref_type,
void *ref,
H5O_type_t *obj_type
)
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 |
SUBROUTINE h5rget_object_type_f(dset_id, ref, obj_type, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference
INTEGER, INTENT(OUT) :: obj_type ! Object type
! H5G_UNKNOWN_F (-1)
! H5G_LINK_F 0
! H5G_GROUP_F 1
! H5G_DATASET_F 2
! H5G_TYPE_F 3
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5rget_object_type_f
| Release | C |
| 1.8.0 | The function
H5Rget_obj_type renamed to H5Rget_obj_type1
and deprecated in this release.
The macro H5Rget_obj_type
and the function H5Rget_obj_type2
introduced in this release. |