H5Pregister
is a macro that is mapped to either
H5Pregister1
or
H5Pregister2
,
depending on the needs of the application.
Such macros are provided to facilitate application compatibility. For example:
H5Pregister
macro
will be mapped to H5Pregister1
and
will use the H5Pregister1
syntax
(first signature above)
if an application is coded for HDF5 Release 1.6.x.
H5Pregister
macro
mapped to H5Pregister2
and
will use the H5Pregister2
syntax
(second signature above)
if an application is coded for HDF5 Release 1.8.x.
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,
H5Pregister
is mapped to the most recent version of
the function, currently
H5Pregister2
.
If the library and/or application is compiled for Release 1.6
emulation, H5Pregister
will be mapped to
H5Pregister1
.
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 | H5Pregister mapping |
---|---|
Global settings |
|
No compatibility flag | H5Pregister2 |
Enable deprecated symbols | H5Pregister2 |
Disable deprecated symbols | H5Pregister2 |
Emulate Release 1.6 interface | H5Pregister1 |
Function-level macros |
|
H5Pregister_vers = 2 |
H5Pregister2 |
H5Pregister_vers = 1 |
H5Pregister1 |
H5Pregister
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
H5Pregister1
.
Signature [2] above was introduced with HDF5 Release 1.8.0
and is the recommended and default interface.
It is directly callable as
H5Pregister2
.
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.
SUBROUTINE h5pregister_f IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to register 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 h5pregister_f
Release | C |
1.8.0 | The function
H5Pregister renamed to
H5Pregister1
and deprecated in this release.
The macro H5Pregister
and the function H5Pregister2
introduced in this release. |