Last modified: 8 May 2009
Name: H5Pget_chunk_cache
Signature:
  herr_t `H5Pget_chunk_cache`( hid_t `dapl_id`, size_t *`rdcc_nslots`, size_t *`rdcc_nbytes`, double *`rdcc_w0` )

Purpose:
  Retrieves the raw data chunk cache parameters.

Description:
  `H5Pget_chunk_cache` retrieves the number of chunk slots in the raw data chunk cache hash table , the maximum possible number of bytes in the raw data chunk cache, and the preemption policy value.

  These values are retrieved from a dataset access property list. If the values have not been set on the property list, then values returned will be the corresponding values from a default file access property list.

  Any (or all) pointer arguments may be null pointers, in which case the corresponding datua is not returned.

Parameters:

  hid_t `plist_id` |  | IN: Dataset access property list identifier.
  size_t *`rdcc_nslots` |  | OUT: Number of chunk slots in the raw data chunk cache hash table.
  size_t *`rdcc_nbytes` |  | OUT: Total size of the raw data chunk cache, in bytes.
  double *`rdcc_w0` |  | OUT: Preemption policy.

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

Example Usage:
  The following code retrieves the chunk cache settings on the dataset access property list `dapl_id` into local variables:

      size_t nslots, nbytes;
      double w0;
      status = H5Pget_chunk_cache(dapl_id, &nslots, &nbytes, &w0);

Fortran90 Interface: h5pget_chunk_cache_f

        SUBROUTINE h5pget_chunk_cache_f(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
          IMPLICIT NONE
          INTEGER(HID_T), INTENT(IN) :: dapl_id       ! Dataset access property list identifier.
          INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nslots ! Number of chunk slots in the raw data chunk
                                                      ! cache hash table.
          INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes ! Total size of the raw data chunk cache, in bytes.
          REAL, INTENT(OUT) :: rdcc_w0                ! Preemption policy.
          INTEGER, INTENT(OUT) :: hdferr              ! error code
                                                      ! 0 on success and -1 on failure
        END SUBROUTINE h5pget_chunk_cache_f

See Also:
  `H5Pset_chunk_cache`

History:

  Release | Change
  1.8.3 | C function introduced in this release.