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


H5P_GET_EVICT_ON_CLOSE ( fapl_id, evict_on_close )


<pre><code class="language-c">herr_t H5Pget_evict_on_close(
      hid_t fapl_id, 
      hbool_t *evict_on_close)

hid_t fapl_idIN: File access property list
hbool_t * evict_on_closeOUT: Pointer to an hbool_t variable that will indicate if the object will be evicted on close


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.


Returns a non-negative value if successful. Otherwise returns a negative value.



Coming Soon!

Release    Change
1.10.1C function introduced with this release.