Last modified: 29 August 2012
Name: H5Topen

Signature:
hid_t H5Topen( hid_t loc_id, const char * name )

hid_t H5Topen( hid_t loc_id, const char * name, hid_t tapl_id )

Purpose:
Opens a named datatype.

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

Global settings
No compatibility flag H5Topen2 
Enable deprecated symbols H5Topen2 
Disable deprecated symbols H5Topen2 
Emulate Release 1.6 interface     H5Topen1 

Function-level macros
H5Topen_vers = 2 H5Topen2
H5Topen_vers = 1 H5Topen1

The datatype identifier returned by this macro can be released with H5Tclose when the identifier is no longer needed so that resource leaks will not develop.

Fortran90 Interface: h5topen_f
SUBROUTINE h5topen_f(loc_id, name, type_id, hdferr, tapl_id)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name   ! Datatype name within file or group
  INTEGER(HID_T), INTENT(OUT) :: type_id ! Datatype identifier
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id 
                                         ! Datatype access property list id
END SUBROUTINE h5topen_f
    

History:
Release     C
1.8.0 The function H5Topen renamed to H5Topen1 and deprecated in this release.
The macro H5Topen and the function H5Topen2 introduced in this release.