File: H5Iget_type.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 (40 lines) | stat: -rw-r--r-- 852 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
35
36
37
38
39
40
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/H5I.R
\name{H5Iget_type}
\alias{H5Iget_type}
\title{Find the type of an object}
\usage{
H5Iget_type(h5identifier)
}
\arguments{
\item{h5identifier}{Object of class \linkS4class{H5IdComponent}.}
}
\value{
Returns a character vector of length 1 containing the HDF5 type
for the supplied identifier.
}
\description{
Possible types returned by the function are:
\itemize{
\item \code{H5I_FILE}
\item \code{H5I_GROUP}
\item \code{H5I_DATATYPE}
\item \code{H5I_DATASPACE}
\item \code{H5I_DATASET}
\item \code{H5I_ATTR}
}
}
\examples{
h5file <- system.file("testfiles", "h5ex_t_array.h5", package="rhdf5")
fid <- H5Fopen(h5file)
gid <- H5Gopen(fid, "/")

## identify the HDF5 types for these identifiers
H5Iget_type(fid)
H5Iget_type(gid)

## tidy up
H5Gclose(gid)
H5Fclose(fid)

}