Clears the external link open file cache

Procedure:

H5F_CLEAR_ELINK_FILE_CACHE(file_id)

Signature:

<pre><code class="language-c">herr_t H5Fclear_elink_file_cache( hid_t file_id )</code></pre>

Parameters:
hid_t file_idIN: File identifier

Description:

H5F_CLEAR_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.

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

Returns:

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

Example Usage:

The following C code clears the external file cache for the file specified by file_id:

    status = H5Fclear_elink_file_cache(file_id)         

See Also:

H5P_SET_ELINK_FILE_CACHE_SIZE
H5P_GET_ELINK_FILE_CACHE_SIZE

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