File: H5Pshared_mesg_index.Rd

package info (click to toggle)
r-bioc-rhdf5 2.50.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,584 kB
  • sloc: ansic: 8,521; cpp: 91; makefile: 11; python: 9; sh: 6
file content (34 lines) | stat: -rw-r--r-- 1,148 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/H5P.R
\name{H5Pset_shared_mesg_index}
\alias{H5Pset_shared_mesg_index}
\alias{H5Pget_shared_mesg_index}
\title{Get and set shared object header message index properties}
\usage{
H5Pset_shared_mesg_index(
  h5plist,
  index_num,
  mesg_type_flags = h5default(type = "H5O_SHMESG_FLAG"),
  min_mesg_size
)

H5Pget_shared_mesg_index(h5plist, index_num)
}
\arguments{
\item{h5plist}{\linkS4class{H5IdComponent} object representing the file creation
property list}

\item{index_num}{Index being configured.  Indices use C-style 0-based counting, so the first index will be numbered 0.}

\item{mesg_type_flags}{Character specifying the types of messages that may be stored in this index.
Valid values can be found with \code{h5const(type = "H5O_SHMESG_FLAG")}}

\item{min_mesg_size}{Minimum message size}
}
\value{
\code{H5Pget_shared_mesg_index()} returns a list of length 2. The first element is the types of messages
that may be stored in the index, the second element is the minimum message size.
}
\description{
Get and set shared object header message index properties
}