Last modified: 9 October 2014
Name: H5Dopen

hid_t H5Dopen( hid_t loc_id, const char *name )

hid_t H5Dopen( hid_t loc_id, const char *name, hid_t dapl_id )

Opens an existing dataset.

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

Global settings
No compatibility flag H5Dopen2 
Enable deprecated symbols H5Dopen2 
Disable deprecated symbols H5Dopen2 
Emulate Release 1.6 interface     H5Dopen1 

Function-level macros
H5Dopen_vers = 2 H5Dopen2
H5Dopen_vers = 1 H5Dopen1

A dataset opened with this macro should be closed with H5Dclose when the dataset is no longer needed so that resource leaks will not develop.

Fortran90 Interface: h5dopen_f
SUBROUTINE h5dopen_f(loc_id, name, dset_id, hdferr, dapl_id)
  INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the dataset 
  INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier
  INTEGER, INTENT(OUT) :: hdferr         ! Error code: 
                                         ! 0 on success and -1 on failure
                                         ! Dataset access property list
See Also:
“Using Identifiers”

Release     C
1.8.0 The function H5Dopen renamed to H5Dopen1 and deprecated in this release.
The macro H5Dopen and the function H5Dopen2 introduced in this release.