Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_EVICT_ON_CLOSE

Controls the library's behavior of evicting metadata associated with a closed object

Procedure:

H5P_SET_EVICT_ON_CLOSE ( fapl_id, evict_on_close )

Signature:


     herr_t H5Pset_evict_on_close(
       hid_t fapl_id, 
       hbool_t evict_on_close)
        
    

Parameters:
hid_t fapl_idIN: File access property list
hbool_t evict_on_closeIN: Whether the HDF5 object should be evicted on close

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 evicted from the cache as long as metadata is not referenced by any other open object.

This function only applies to file access property lists.

The default library behavior is to not evict on object or file close.

When applied to a file access property list, any subsequently opened object will inherit the "evict on close" property and will have its metadata evicted when the object is closed.

Returns:
 

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

Example:

Coming Soon!

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

--- Last Modified: December 04, 2017 | 08:39 AM