H5P_GET_SHARED_MESG_INDEX
Retrieves the configuration settings for a shared message index
Procedure:
H5P_GET_SHARED_MESG_INDEX ( fcpl_id, index_num, mesg_type_flags, min_mesg_size )
Signature:
herr_t H5Pget_shared_mesg_index(
hid_t fcpl_id,
unsigned index_num,
unsigned *mesg_type_flags,
unsigned *min_mesg_size
)
Parameters:
hid_t fcpl_id | IN: File creation property list identifier |
unsigned index_num | IN: Index being configured |
unsigned *mesg_type_flags | OUT: Types of messages that may be stored in this index |
unsigned *min_mesg_size | OUT: Minimum message size |
Description:
H5P_GET_SHARED_MESG_INDEX retrieves the message type and minimum message size settings from the file creation property list fcpl_id for the shared object header message index specified by index_num.
index_num specifies the index. index_num is zero-indexed, so in a file with three indexes, they will be numbered 0, 1, and 2.
mesg_type_flags and min_mesg_size will contain, respectively, the types of messages and the minimum size, in bytes, of messages that can be stored in this index.
Valid message types are described in H5P_SET_SHARED_MESG_INDEX.
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: May 01, 2019 | 03:46 PM
