Returns information about a filter in a pipeline
H5P_GET_FILTER2 ( plist_id, idx, flags, cd_nelmts, cd_values, namelen, name, filter_config )
H5Z_filter_t H5Pget_filter2( hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values, size_t namelen, char name, unsigned *filter_config )
Fortran90 Interface: h5pget_filter_f SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier INTEGER, INTENT(IN) :: filter_number ! Sequence number within the filter ! pipeline of the filter for which ! information is sought 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(INOUT) :: cd_nelmts ! Number of elements in cd_values INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters ! in name CHARACTER(LEN=*), INTENT(OUT) :: name ! Name of the filter INTEGER, INTENT(OUT) :: filter_id ! Filter identification number INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5pget_filter_f
|hid_t ||IN: Dataset or group creation property list identifier|
|int ||IN: Sequence number within the filter pipeline of the filter for which information is sought|
|unsigned int * ||OUT: Bit vector specifying certain general properties of the filter|
|size_t * ||IN/OUT: Number of elements in |
|unsigned int * ||OUT: Auxiliary data for the filter|
|size_t ||IN: Anticipated number of characters in |
|char ||OUT: Name of the filter|
|unsigned int * ||OUT: Bit field, as described in |
H5P_GET_FILTER2 returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated.
plist_id must be a dataset or group creation property list.
idx is a value between zero and N-1, as described in
H5P_GET_NFILTERS. The function will return a negative value if the filter number is out of range.
The structure of the
flags argument is discussed in
cd_nelmts indicates the number of entries in the
cd_values array, as allocated by the caller; on return,
cd_nelmts contains the number of values defined by the filter.
name is a pointer to an array of at least
namelen bytes, the filter name will be copied into that array. The name will be null terminated if
namelen is large enough. The filter name returned will be the name appearing in the file, the name registered for the filter, or an empty string.
filter_config is the bit field described in
Returns the filter identifier if successful:
|Data compression filter, employing the gzip algorithm|
|Data shuffling filter|
|Error detection filter, employing the Fletcher32 checksum algorithm|
|Data compression filter, employing the SZIP algorithm|
|Data compression filter, employing the N-bit algorithm|
|Data compression filter, employing the scale-offset algorithm|
Otherwise returns a negative value.
|1.8.0||Function introduced in this release.|
|1.8.5||Function extended to work with group creation property lists.|