Last modified: 18 March 2016

Name: H5Pset_coll_metadata_write

Signature:
herr_t H5Pset_coll_metadata_write( hid_t fapl_id, hbool_t is_collective )

Purpose:
Sets metadata write mode to collective or independent (default).

Description:
H5Pset_coll_metadata_write tells the HDF5 Library whether to perform metadata writes collectively (TRUE) or independently (FALSE).

If collective access is selected, then on a flush of the metadata cache, all processes will divide the metadata cache entries to be flushed evenly among themselves and issue a single MPI-IO collective write operation. This is the preferred method when the size of the metadata created by the application is large.

If independent access is selected, the library uses the default method for doing metadata I/O either from process zero or independently from each process.


Parameters:
hid_t fapl_id   IN: File access propery list identifier
hbool_t is_collective   IN: Boolean value indicating whether metadata writes are collective (TRUE) or independent (FALSE)
Default mode: Independent (FALSE)

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

Fortran Interface: h5pset_coll_metadata_write_f
Signature:
  SUBROUTINE h5pset_coll_metadata_write_f(plist_id, is_collective, hdferr)
    INTEGER(HID_T)  , INTENT(IN)  :: plist_id
    LOGICAL, INTENT(IN)           :: is_collective
    INTEGER, INTENT(OUT)          :: hdferr
Inputs:
  fapl_id        - File access property list identifier.
  is_collective  - Indicates if metadata writes are collective or not.
Outputs:
  hdferr         - Returns 0 if successful and -1 if fails.

See Also:

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