Last modified: 11 May 2011
Name: H5Fclear_elink_file_cache
Signature:
herr_t H5Fclear_elink_file_cache( hid_t file_id )

Purpose:
Clears the external link open file cache.

Motivation:
H5Fclear_elink_file_cache releases all the child files cached in a file’s external link open file cache, possibly causing them to be closed. This function can be used to release memory and to allow files to be accessed by another process.

Description:
H5Fclear_elink_file_cache evicts all the cached child files in the specified file’s external file cache, causing them to be closed if there is nothing else holding them open.

H5Fclear_elink_file_cache does not close the cache itself; subsequent external link traversals from the parent file will again cache the target file. See H5Pset_elink_file_cache_size for information on closing the file cache.

Parameters:
hid_t file_id      IN: File identifier

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

Example Usage:
The following code clears the external file cache for the file specified by file_id:
    status = H5Fclear_elink_file_cache(file_id)         

See Also:
H5Pset_elink_file_cache_size
H5Pget_elink_file_cache_size

History:
Release     Change
1.8.7 C function introduced in this release.