Last modified: 29 September 2011
Name: H5Pregister
Signatures:
herr_t H5Pregister( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, 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 H5Pregister( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, 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:
Returns information about the specified filter.

Description:
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:

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

Interface history:   Signature [1] above is the original 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.

Fortran90 Interface: h5pregister_f

Fortran2003 Interface: h5pregister_f

History:
Release     C
1.8.8 Fortran updated to Fortran2003.
1.8.0 The function C function H5Pregister renamed to H5Pregister1 and deprecated in this release.
C macro H5Pregister and C function H5Pregister2 introduced in this release.