Page tree

The license could not be verified: License Certificate has expired!

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_FILTER_BY_ID

Returns information about the specified filter

Procedure:

H5P_GET_FILTER_BY_ID ( plist_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, filter_config )

Signature:

[1] herr_t H5Pget_filter_by_id(
            hid_t plist_id,
            H5Z_filter_t filter_id,
            unsigned int *flags,
            size_t *cd_nelmts,
            unsigned int cd_values[],
            size_t namelen,
            char name[] )
            

[2] herr_t H5Pget_filter_by_id(
            hid_t plist_id,
            H5Z_filter_t filter_id,
            unsigned int *flags,
            size_t *cd_nelmts,
            unsigned int cd_values[],
            size_t namelen,
            char name[],
            unsigned int *filter_config )

Fortran90 Interface:  h5pget_filter_by_id_f
    
SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts,
                                 cd_values, namelen, name, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier
  INTEGER, INTENT(IN)        :: filter_id   ! Filter identifier
  INTEGER(SIZE_T), INTENT(INOUT)     :: cd_nelmts  
                                            ! Number of elements in cd_values
  INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
                                            ! Auxiliary data for the filter
  INTEGER, INTENT(OUT)          :: flags    ! Bit vector specifying certain 
                                            ! general properties of the filter
  INTEGER(SIZE_T), INTENT(IN)   :: namelen  ! Anticipated number of characters 
                                            ! in name
  CHARACTER(LEN=*), INTENT(OUT) :: name     ! Name of the filter
  INTEGER, INTENT(OUT)          :: hdferr   ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pget_filter_by_id_f
	

Description:

H5P_GET_FILTER_BY_ID(C) is a macro that is mapped to either H5P_GET_FILTER_BY_ID1 or H5P_GET_FILTER_BY_ID2, depending on the needs of the application.

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

  • The H5P_GET_FILTER_BY_ID macro will be mapped to H5P_GET_FILTER_BY_ID1 and will use the H5P_GET_FILTER_BY_ID1 syntax (first signature above) if an application is coded for HDF5 Release 1.6.x.
  • The H5P_GET_FILTER_BY_ID macro mapped to H5P_GET_FILTER_BY_ID2  and will use the H5P_GET_FILTER_BY_ID2 syntax (second signature above) if an application is coded for HDF5 Release 1.8.x.

For more information on macro use and mappings, see the “API Compatibility Macros in HDF5” document.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5P_GET_FILTER_BY_ID is mapped to the most recent version of the function, currently H5P_GET_FILTER_BY_ID2 . If the library and/or application is compiled for Release 1.6 emulation, H5P_GET_FILTER_BY_ID will be mapped to H5P_GET_FILTER_BY_ID1. 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 settingH5Pget_filter_by_id mapping

Global settings
No compatibility flagH5P_GET_FILTER_BY_ID2 
Enable deprecated symbolsH5P_GET_FILTER_BY_ID2 
Disable deprecated symbolsH5P_GET_FILTER_BY_ID2 
Emulate Release 1.6 interfaceH5P_GET_FILTER_BY_ID1 

Function-level macros
H5Pget_filter_by_id_vers = 2    H5P_GET_FILTER_BY_ID2
H5Pget_filter_by_id_vers = 1

H5P_GET_FILTER_BY_ID1

 

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

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

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.

 

Example:

Coming Soon!

History:
Release    C
1.8.0The function H5P_GET_FILTER_BY_ID renamed to H5P_GET_FILTER_BY_ID1 and deprecated in this release.
The macro H5P_GET_FILTER_BY_ID and the function H5P_GET_FILTER_BY_ID2 introduced in this release.

--- Last Modified: December 19, 2017 | 01:32 PM