Name: H5Pinsert
Signatures:
herr_t H5Pinsert( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_close_func_t close )
 
[1]
herr_t H5Pinsert( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close ) [2]

Purpose:
Registers a temporary property with a property list.

Description:
H5Pinsert is a macro that is mapped to either H5Pinsert1 or H5Pinsert2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

Macro 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, H5Pinsert is mapped to the most recent version of the function, currently H5Pinsert2. If the library and/or application is compiled for Release 1.6 emulation, H5Pinsert will be mapped to H5Pinsert1. 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 H5Pinsert mapping

Global settings
No compatibility flag H5Pinsert2 
Enable deprecated symbols H5Pinsert2 
Disable deprecated symbols H5Pinsert2 
Emulate Release 1.6 interface H5Pinsert1 

Function-level macros
H5Pinsert_vers = 2     H5Pinsert2
H5Pinsert_vers = 1 H5Pinsert1

Interface history:   Signature [1] above is the original H5Pinsert interface and the only interface available prior to HDF5 Release 1.8.0. This signature and the corresponding function are now deprecated but will remain directly callable as H5Pinsert1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable as H5Pinsert2.

See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.

Fortran90 Interface: h5pinsert_f
SUBROUTINE h5pinsert_f
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist   ! Property list class identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
  INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value	
  TYPE,   INTENT(IN) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pinsert_f
	

History:
Release     C
1.8.0 The function H5Pinsert renamed to H5Pinsert1 and deprecated in this release.
The macro H5Pinsert and the function H5Pinsert2 introduced in this release.