Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_FILTER_BY_ID2

Returns information about the specified filter

Procedure:

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

Signature:

herr_t H5Pget_filter_by_id2(
            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
            )
  

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
	

Parameters:
hid_t plist_idIN: Dataset or group creation property list identifier
H5Z_filter_t filter_idIN: Filter identifier
unsigned int *flagsOUT: Bit vector specifying certain general properties of the filter
size_t *cd_nelmtsIN/OUT: Number of elements in cd_values
unsigned int *cd_valuesOUT: Auxiliary data for the filter
size_t namelenIN: Length of filter name and number of elements in name[]
char name[]OUT: Name of filter
unsigned int *filter_config    OUT: Bit field, as described in H5Z_GET_FILTER_INFO

Description:

H5P_GET_FILTER_BY_ID2 returns information about the filter specified in filter_id, a filter identifier.

plist_id must be a dataset or group creation property list and filter_id must be in the associated filter pipeline.

The filter_id and flags parameters are used in the same manner as described in the discussion of H5P_SET_FILTER.

Aside from the fact that they are used for output, the parameters cd_nelmts and cd_values[] are used in the same manner as described in the discussion of H5P_SET_FILTER. On input, the cd_nelmts parameter indicates the number of entries in the cd_values[] array allocated by the calling program; on exit it contains the number of values defined by the filter.

On input, the namelen parameter indicates the number of characters allocated for the filter name by the calling program in the array name[]. On exit name[] contains the name of the filter with one character of the name in each element of the array.

filter_config is the bit field described in H5Z_GET_FILTER_INFO.

If the filter specified in filter_id is not set for the property list, an error will be returned and H5P_GET_FILTER_BY_ID2 will fail.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    Change
1.8.0Function introduced in this release.
1.8.5Function extended to work with group creation property lists.

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