Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5F_GET_MDC_LOGGING_STATUS

Gets the current metadata cache logging status

Procedure:

H5F_GET_MDC_LOGGING_STATUS(file_id, is_enabled, is_currently_logging)

Signature:

herr_t H5Fget_mdc_logging_status( hid_t file_id, hbool_t *is_enabled, hbool_t *is_currently_logging )

Parameters:
hid_t file_id IN: Identifier of an open HDF5 file
hbool_t *is_enabled OUT: Whether logging is enabled
hbool_t *is_currently_logging   OUT: Whether events are currently being logged

Description:

The metadata cache is a central part of the HDF5 library through which all file metadata reads and writes take place. File metadata is normally invisible to the user and is used by the library for purposes such as locating and indexing data. File metadata should not be confused with user metadata, which consists of attributes created by users and attached to HDF5 objects such as datasets via H5A API calls.

Due to the complexity of the cache, a trace/logging feature has been created that can be used by HDF5 developers for debugging and performance analysis. The functions that control this functionality will normally be of use to a very limited number of developers outside of The HDF Group. The functions have been documented to help users create logs that can be sent with bug reports.

Control of the log functionality is straightforward. Logging is enabled via the H5P_SET_MDC_LOG_OPTIONSfunction, which will modify the file access property list used to open or create a file. This function has a flag that determines whether logging begins at file open or starts in a paused state. Log messages can then be controlled via the HF5_START/STOP_LOGGING functions. H5P_GET_MDC_LOG_OPTIONS can be used to examine a file access property list, and H5F_GET_MDC_LOGGING_STATUS will return the current state of the logging flags.

The log format is described in the Metadata Cache Logging document.

Unlike H5F_START_MDC_LOGGING/H5F_START_MDC_STOP_LOGGING, this function can be called on any open file identifier.

Returns:

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

Example:

Coming soon!

History:
ReleaseChange
1.10.0C function introduced with this release.

--- Last Modified: May 18, 2018 | 02:36 PM