Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_SHARED_MESG_INDEX

Configures the specified shared object header message index

Procedure:

H5P_SET_SHARED_MESG_INDEX ( fcpl_id, index_num, mesg_type_flags, min_mesg_size )

Signature:

herr_t H5Pset_shared_mesg_index(
        hid_t fcpl_id,
        unsigned index_num,
        unsigned mesg_type_flags,
        unsigned min_mesg_size
    )
  

Fortran90 Interface: h5pset_shared_mesg_index_f
   
SUBROUTINE h5pset_shared_mesg_index_f(fcpl_id, index_num, mesg_type_flags,    &
           min_mesg_size, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: fcpl_id  ! File creation property list
  INTEGER, INTENT(IN) :: index_num       ! Index being configured.
  INTEGER, INTENT(IN) :: mesg_type_flags ! Types of messages that should be 
                                         ! stored in this index.
  INTEGER, INTENT(IN) :: min_mesg_size   ! Minimum message size.
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pset_shared_mesg_index_f
    

Parameters:
hid_t fcpl_idIN: File creation property list identifier
unsigned index_numIN: Index being configured
unsigned mesg_type_flags    IN: Types of messages that should be stored in this index
unsigned min_mesg_sizeIN: Minimum message size

Description:

H5Pset_shared_mesg_index is used to configure the specified shared object header message index, setting the types of messages that may be stored in the index and the minimum size of each message.

fcpl_id specifies the file creation property list.

index_num specifies the index to be configured. 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 specify, respectively, the types and minimum size of messages that can be stored in this index.

Valid message types are as follows:

 

H5O_SHMESG_NONE_FLAGNo shared messages
H5O_SHMESG_SDSPACE_FLAG    Simple dataspace message
H5O_SHMESG_DTYPE_FLAGDatatype message
H5O_SHMESG_FILL_FLAGFill value message
H5O_SHMESG_PLINE_FLAGFilter pipeline message
H5O_SHMESG_ATTR_FLAGAttribute message
H5O_SHMESG_ALL_FLAGAll message types; i.e., equivalent to the following:
(H5O_SHMESG_SDSPACE_FLAG | H5O_SHMESG_DTYPE_FLAG | H5O_SHMESG_FILL_FLAG | H5O_SHMESG_PLINE_FLAG | H5O_SHMESG_ATTR_FLAG)

Returns:

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

Example:

Coming Soon!

History:
Release    C
1.8.0Function introduced in this release.

--- Last Modified: January 03, 2018 | 02:36 PM