Last modified: 12 August 2009
Name: H5Pget_filter_by_id
Signature:
herr_t H5Pget_filter_by_id( hid_t plist_id, H5Z_filter_t filter, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char name[] )
Purpose:
Returns information about the specified filter.
Description:
H5Pget_filter_by_id returns information about the filter specified in filter, a filter identifier.

plist_id must identify a dataset creation property list and filter will be in a permanent filter pipeline.

The filter and flags parameters are used in the same manner as described in the discussion of H5Pset_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 H5Pset_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.

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

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
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
History: