Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5G_OPEN

Opens an existing group in a file

Signature:

hid_t H5Gopen( hid_t loc_id, const char *name )
hid_t H5Gopen( hid_t loc_id, const char * name, hid_t gapl_id )

SUBROUTINE h5gopen_f(loc_id, name, grp_id, hdferr, gapl_id)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group 
  INTEGER(HID_T), INTENT(OUT) :: grp_id  ! File identifier 
  INTEGER, INTENT(OUT) :: hdferr         ! Error code  
                                         ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id  
                                         ! Group access property list identifier
END SUBROUTINE h5gopen_f

Description:

H5G_OPEN is a macro that is mapped to either H5G_OPEN1 or H5G_OPEN2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For more information on macro use and mappings, see the API Compatibility Macros in HDF5 document.

When both the HDF5 library and the application are built and installed with no specific compatibility flags, H5G_OPEN is mapped to the most recent version of the function, currently H5G_OPEN2. If the library and/or application is compiled for Release 1.6 emulation, H5G_OPEN will be mapped to H5G_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 settingH5Gopen mapping

Global settings
No compatibility flagH5Gopen2 
Enable deprecated symbolsH5Gopen2 
Disable deprecated symbolsH5Gopen2 
Emulate Release 1.6 interface    H5Gopen1 

Function-level macros
H5Gopen_vers = 2H5Gopen2
H5Gopen_vers = 1H5Gopen1

A group created with this macro should be closed with H5G_CLOSE when the group is no longer needed so that resource leaks will not develop.

History:
Release    Change
1.8.0The function H5Gopen renamed to H5Gopen1 and deprecated in this release. 
The macro H5Gopen and the function H5Gopen2 introduced in this release.

--- Last Modified: April 25, 2018 | 02:32 PM