Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_ARE_MDC_FLUSHES_DISABLED

Determines if an HDF5 object has had flushes of metadata entries disabled

Procedure:

H5O_ARE_MDC_FLUSHES_DISABLED(object_id, are_disabled)

Signature:

herr_t H5Oare_mdc_flushes_enabled(
              hid_t object_id, 
              hbool_t *are_disabled
        )

Parameters:
hid_t object_idIN: Identifier of an object in the cache; may be a group, named datatype, or dataset identifier
hbool_t *are_disabled   OUT: Flushes enabled/disabled

Description:

H5O_ARE_MDC_FLUSHES_DISABLED determines if an HDF5 object (dataset, group, committed datatype) has had flushes of metadata entries disabled.

The H5O_/H5F_ ENABLE/DISABLE_MDC_FLUSHES and associated H5X_FLUSH functions can be used to control the flushing of entries from a file’s metadata cache. Metadata cache entries can be controlled at both the individual HDF5 object level (datasets, groups, committed datatypes) and the entire metadata cache level.

HDF5 objects include datasets, groups, and committed datatypes. Only hid_t identifiers that represent these objects can be passed to the function.

Passing in a hid_t identifier that represents any other HDF5 entity is considered an error.

It is an error to pass an HDF5 file identifier (obtained from H5F_OPEN or H5F_CREATE) to this function. Use H5F_ARE_MDC_FLUSHES_DISABLED instead.

Returns:

are_disabled will be set to 1 if an object has had flushes disabled and 0 if it has not had flushes disabled.

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

Example:

Coming Soon!

History:
Release    Change
1.10.0C function introduced with this release.

--- Last Modified: June 02, 2020 | 09:22 AM