H5P_SET_SHARED_MESG_NINDEXES
Sets number of shared object header message indexes
Procedure:
H5P_SET_SHARED_MESG_NINDEXES ( plist_id, nindexes )
Signature:
herr_t H5Pset_shared_mesg_nindexes(
hid_t plist_id,
unsigned nindexes
)
Fortran90 Interface: h5pset_shared_mesg_nindexes_f
SUBROUTINE h5pset_shared_mesg_nindexes_f( plist_id, nindexes, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: plist_id ! File creation property list
INTEGER, INTENT(IN) :: nindexes ! Number of shared object header message
! indexes available in files created
! WITH this property list
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5pset_shared_mesg_nindexes_f
Parameters:
hid_t plist_id | IN: File creation property list |
unsigned nindexes | IN: Number of shared object header message indexes to be available in files created with this property list (nindexes must be <= H5O_SHMESG_MAX_INDEXES (8)) |
Description:
H5P_SET_SHARED_MESG_NINDEXES sets the number of shared object header message indexes in the specified file creation property list.
This setting determines the number of shared object header message indexes, nindexes, that will be available in files created with this property list. These indexes can then be configured with H5P_SET_SHARED_MESG_INDEX.
If nindexes is set to 0 (zero), shared object header messages are disabled in files created with this property list.
There is a limit of H5O_SHMESG_MAX_INDEXES (8) that can be set with H5P_SET_SHARED_MESG_NINDEXES. An error will occur if specifying a value of nindexes that is greater than this value.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.8.0 | Function introduced in this release. |
--- Last Modified: February 19, 2020 | 08:20 AM
