Last modified: 2016

Name: H5Pget_evict_on_close

Signature:
herr_t H5Pget_evict_on_close( hid_t fapl_id, hbool_t *evict_on_close)

Purpose:
Retrieves the file access property list setting that determines whether an HDF5 object will be evicted from the library's metadata cache when it is closed.

Description:

The library's metadata cache is fairly conservative about holding on to HDF5 object metadata (object headers, chunk index structures, etc.), which can cause the cache size to grow, resulting in memory pressure on an application or system. When enabled, the "evict on close" property will cause all metadata for an object to be immediately evicted from the cache as long as it is not referenced by any other open object.

This function only applies to file access property lists.

See H5Pset_evict_on_close() for additional notes on behavior.

Parameters:
hid_t fapl_id   IN: File access property list
hbool_t * evict_on_close   OUT: Pointer to an hbool_t variable that will indicate if the object will be evicted on close.
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.

Fortran Interface:
None

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