File: H5Pfill_value_defined.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 (25 lines) | stat: -rw-r--r-- 894 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/H5P.R
\name{H5Pfill_value_defined}
\alias{H5Pfill_value_defined}
\title{Determine whether a property list has a fill value defined}
\usage{
H5Pfill_value_defined(h5plist)
}
\arguments{
\item{h5plist}{Object of class \linkS4class{H5IdComponent} representing a dataset
creation property list.}
}
\value{
\code{TRUE} if the fill value is defined, \code{FALSE} if not.  Will return
\code{NULL} if there is a problem determining the status of the fill value.
}
\description{
Determine whether a property list has a fill value defined
}
\details{
Note that the return value for this function is slightly different
from the C version.  The C API provides three return types and can, in the
case that a fill value is defined, differentiate whether the value is the
HDF5 library default or has been set by the application.
}