Page tree

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

 

JAVA

FORTRAN

C++

C

 

Link

H5P_MODIFY_FILTER

Modifies a filter in the filter pipeline

Procedure:

H5P_MODIFY_FILTER ( plist_id, filter_id, flags, cd_nelmts, cd_values )

Signature:

herr_t H5Pmodify_filter(
        hid_t plist_id,
        H5Z_filter_t filter_id,
        unsigned int flags,
        size_t cd_nelmts,
        const unsigned int cd_values[]
    )
  

Fortran90 Interface: h5pmodify_filter_f
    
SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, & 
                              cd_values, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier
  INTEGER, INTENT(IN)        :: filter      ! Filter to be modified
  INTEGER, INTENT(IN)        :: flags       ! Bit vector specifying certain 
                                            ! general properties of the filter
  INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts  ! Number of elements in cd_values
  INTEGER, DIMENSION(*), INTENT(IN) :: cd_values  
                                            ! Auxiliary data for the filter
  INTEGER, INTENT(OUT)       :: hdferr      ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pmodify_filter_f
    

Parameters:
hid_t plist_idIN: Dataset or group creation property list identifier
H5Z_filter_t filter_idIN: Filter to be modified
unsigned int flagsIN: Bit vector specifying certain general properties of the filter
size_t cd_nelmtsIN: Number of elements in cd_values
const unsigned int cd_values[]    IN: Auxiliary data for the filter

Description:

H5P_MODIFY_FILTER modifies the specified filter_id in the filter pipeline. plist_id must be a dataset or group creation property list.

The filter_id, flags cd_nelmts[], and cd_values parameters are used in the same manner and accept the same values as described in the discussion of H5P_SET_FILTER.

Returns:

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

Example:

Coming Soon!

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

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