Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5D_OPEN

Opens an existing dataset

Signature:

hid_t H5Dopenhid_t loc_idconst char *name ) 

hid_t H5Dopenhid_t loc_idconst char *namehid_t dapl_id )

SUBROUTINE h5dopen_f(loc_id, name, dset_id, hdferr, dapl_id)
  IMPLICIT NONE
  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
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: dapl_id 
                                         ! Dataset access property list
END SUBROUTINE h5dopen_f

Description:

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

Global settings
No compatibility flagH5Dopen2 
Enable deprecated symbolsH5Dopen2 
Disable deprecated symbolsH5Dopen2 
Emulate Release 1.6 interface    H5Dopen1 

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

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

Example:

Coming Soon!

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

--- Last Modified: December 18, 2018 | 01:33 PM