Obtains current metadata cache size data for specified file

Procedure:

H5F_GET_MDC_SIZE (file_id, max_size_ptr, min_clean_size_ptr, cur_size_ptr, cur_num_entries_ptr)

Signature:

<pre><code class="language-c">herr_t H5Fget_mdc_size(hid_t file_id, size_t *max_size_ptr, size_t *min_clean_size_ptr, size_t *cur_size_ptr, int *cur_num_entries_ptr)</code></pre>

Parameters:
hid_t file_idIN: Identifier of the target file
size_t *max_size_ptrOUT: Pointer to the location in which the current cache maximum size is to be returned, or NULL if this datum is not desired
size_t *min_clean_size_ptr    OUT: Pointer to the location in which the current cache minimum clean size is to be returned, or NULL if that datum is not desired
size_t *cur_size_ptrOUT: Pointer to the location in which the current cache size is to be returned, or NULL if that datum is not desired
int *cur_num_entries_ptrOUT: Pointer to the location in which the current number of entries in the cache is to be returned, or NULL if that datum is not desired

Description:

H5F_GET_MDC_SIZE  queries the metadata cache of the target file for the desired size information, and returns this information in the locations indicated by the pointer parameters. If any pointer parameter is NULL, the associated data is not returned.

If the API call fails, the values returned via the pointer parameters are undefined.

If adaptive cache resizing is enabled, the cache maximum size and minimum clean size may change at the end of each epoch. Current size and current number of entries can change on each cache access.

Current size can exceed maximum size under certain conditions. See the overview of the metadata cache in the special topics section of the user manual for a discussion of this.

Returns:

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

Example:

Coming soon!