Last modified: 14 June 2010
Name: H5Pget_filter_by_id2
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` )

Purpose:
  Returns information about the specified filter.

Description:
  `H5Pget_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 `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.

  `filter_config` is the bit field described in `H5Zget_filter_info`.

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

Parameters:

hid_t `plist_id` | IN: Dataset or group creation property list identifier.
H5Z_filter_t `filter_id` | IN: Filter identifier.
unsigned int *`flags` | OUT: Bit vector specifying certain general properties of the filter.
size_t *`cd_nelmts` | IN/OUT: Number of elements in `cd_values`.
unsigned int *`cd_values` | OUT: Auxiliary data for the filter.
size_t `namelen` | IN: 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 `H5Zget_filter_info`.

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

Fortran90 Interface: h5pget_filter_by_id_f
  See the `H5Pget_filter_by_id` macro description.

History:

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