Last modified: 23 February 2016

Name: H5Pget_chunk_opts

Signature:
herr_t H5Pget_chunk_opts( hid_t dcpl_id, unsigned *opts )

Purpose:
Retrieves the edge chunk option setting from a dataset creation property list.

Description:
H5Pget_chunk_opts retrieves the edge chunk option setting stored in the dataset creation property list dcpl_id.

Parameters:
hid_t dcpl_id   IN: Dataset creation property list identifier
unsigned opts   OUT: Edge chunk option flag.

Valid values are described in H5Pset_chunk_opts.

The option status can be retrieved using the bitwise AND operator ( & ). For example, the expression (opts&H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS) will evaluate to H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS if that option has been enabled. Otherwise, it will evaluate to 0 (zero).

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

Fortran Interface:
None

See Also:

History:
Release     Change
1.10.0 C function introduced with this release.