Last modified: 18 March 2014

Signature:

herr_t H5Pget_mdc_log_options(
              hid_t fapl_id, 
              hbool_t *is_enabled, 
              char *location, 
              size_t *location_size, 
              hbool_t *start_on_access
        )

Purpose:

Gets metadata cache logging options.

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 H5Pset_mdc_log_options() function, 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 H5Fstart/stop_logging() functions. H5Pget_mdc_log_options() can be used to examine a file access property list, and H5Fget_mdc_logging_status() will return the current state of the logging flags.

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

Notes:

The location_size string must be allocated by the caller. The appropriate size can be determined by calling the function with location_size set to NULL which will return the buffer size in bytes via the location_size pointer.

Parameters:

`hid_t fapl_id`	IN: File access property list identifier.
`hbool_t *is_enabled`	OUT: Whether logging is enabled.
`char *location`	OUT: Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
`size_t *location_size`	OUT: Size in bytes of the location string.
`hbool_t *start_on_access`	OUT: Whether the logging begins as soon as the file is opened or created.

Returns:

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

Fortran Interface:

None

See Also:

History:

Release	Change
1.10.0	C function introduced with this release.