H5P_SET_SHARED_MESG_INDEX

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Configures the specified shared object header message index

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5P_SET_SHARED_MESG_INDEX ( fcpl_id, index_num, mesg_type_flags, min_mesg_size )

Hdf rm anchor

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Pset_shared_mesg_index( hid_t fcpl_id, unsigned index_num, unsigned mesg_type_flags, unsigned min_mesg_size ) </code></pre>

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-fortran

HTML

<pre><code class="language-fortran">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
    </code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t `fcpl_id`	IN: File creation property list identifier
unsigned `index_num`	IN: Index being configured
unsigned `mesg_type_flags`	IN: Types of messages that should be stored in this index
unsigned `min_mesg_size`	IN: Minimum message size

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5PsetH5P_sharedSET_mesgSHARED_indexMESG_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_FLAG`	No shared messages
`H5O_SHMESG_SDSPACE_FLAG`	Simple dataspace message
`H5O_SHMESG_DTYPE_FLAG`	Datatype message
`H5O_SHMESG_FILL_FLAG`	Fill value message
`H5O_SHMESG_PLINE_FLAG`	Filter pipeline message
`H5O_SHMESG_ATTR_FLAG`	Attribute message
`H5O_SHMESG_ALL_FLAG`	All 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)`

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	example

Example:

HTML Wrap

class	hdf-rm-section

Coming Soon!

Comment

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	examples/h5_subset.c
showLineNumbers	true
lineStart	32
progLang	cpp
lineEnd	42
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	fortran/examples/compound.f90
showLineNumbers	true
lineStart	25
progLang	plain
lineEnd	35
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

C

Release	Change
1.8.0	Function introduced in this release.

Page tree

Versions Compared

Old Version 6

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect