Opens the HDF5 object referenced
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 )
Fortran90 Interface: h5rdereference_f
To dereference an object:
Signature:
SUBROUTINE h5rdereference_f(obj_id, ref, ref_obj_id, hdferr)
INTEGER(HID_T) , INTENT(IN) :: obj_id
TYPE(hobj_ref_t_f), INTENT(IN) :: ref
INTEGER(HID_T) , INTENT(OUT) :: ref_obj_id
INTEGER , INTENT(OUT) :: hdferr
Inputs:
obj_id - Valid identifier in file
ref - Object reference
Outputs:
ref_obj_id - Identifier of referenced object
hdferr - Error code
0 on success and -1 on failure
To dereference a region:
Signature:
SUBROUTINE h5rdereference_f(obj_id, ref, ref_obj_id, hdferr)
INTEGER(HID_T) , INTENT(IN) :: obj_id
TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref
INTEGER(HID_T) , INTENT(OUT) :: ref_obj_id
INTEGER , INTENT(OUT) :: hdferr
Inputs:
dset_id - Valid identifier in file
ref - Object reference
Outputs:
ref_obj_id - Identifier of referenced object
hdferr - Error code
0 on success and -1 on failure
Fortran2003 Interface: h5rdereference_f
Signature:
SUBROUTINE h5rdereference_f(obj_id, ref_type, ref, ref_obj_id, hdferr)
INTEGER(HID_T), INTENT(IN) :: obj_id
INTEGER , INTENT(IN) :: ref_type
TYPE(C_PTR) , INTENT(IN) :: ref
INTEGER(HID_T), INTENT(OUT) :: ref_obj_id
INTEGER , INTENT(OUT) :: hdferr
Inputs:
obj_id - Valid identifier for the file containing the
referenced object or any object in that file.
ref_type - The reference type of ref.
ref - Object reference
Outputs:
ref_obj_id - Identifier of referenced object
hdferr - Error code
0 on success and -1 on failure
Description:
H5R_DEREFERENCE is a macro that is mapped to either H5R_DEREFERENCE1 or H5R_DEREFERENCE2, 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, H5R_DEREFERENCE is mapped to the most recent version of the function, currently H5R_DEREFERENCE2. If the library and/or application is compiled for Release 1.6 or 1.8 emulation, H5R_DEREFERENCE will be mapped to H5R_DEREFERENCE1. 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 |
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. |
--- Last Modified: May 03, 2019 | 01:20 PM