Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5T_COMMIT

Commits a transient datatype, linking it into the file and creating a new named datatype.

Signature:

herr_t H5Tcommit( hid_t loc_id, const char *name, hid_t dtype_id )
herr_t H5Tcommit( hid_t loc_id, const char *name, hid_t dtype_id, hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id )

SUBROUTINE h5tcommit_f(loc_id, name, type_id, hdferr, &
                       lcpl_id, tcpl_id, 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(IN) :: type_id ! Datatype identifier 
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id  
                                        ! Link creation property list
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id  
                                        ! Datatype creation property list
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id 
                                        ! Datatype access property list
END SUBROUTINE h5tcommit_f

Description:

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

Global settings
No compatibility flagH5Tcommit2 
Enable deprecated symbolsH5Tcommit2 
Disable deprecated symbolsH5Tcommit2 
Emulate Release 1.6 interface    H5Tcommit1 

Function-level macros
H5Tcommit_vers = 2H5Tcommit2
H5Tcommit_vers = 1H5Tcommit1

History:
Release    C
1.8.0The function H5Tcommit renamed to H5Tcommit1 and deprecated in this release. 
The macro H5Tcommit and the function H5Tcommit2 introduced in this release.

--- Last Modified: January 24, 2018 | 10:27 AM