File: H5Oopen.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 (42 lines) | stat: -rw-r--r-- 950 bytes parent folder | download
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
41
42
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/H5O.R
\name{H5Oopen}
\alias{H5Oopen}
\title{Open an object in an HDF5 file}
\usage{
H5Oopen(h5loc, name)
}
\arguments{
\item{h5loc}{An object of class \linkS4class{H5IdComponent}}

\item{name}{Path to the object to be opened.  This should be relative to
\code{h5loc} rather than the file.}
}
\value{
An object of class \linkS4class{H5IdComponent} if the open operation was
successful. \code{FALSE} otherwise.
}
\description{
Open an object in an HDF5 file
}
\examples{

h5File <- tempfile(pattern = "ex_H5O.h5")

# create an hdf5 file and write something
h5createFile(h5File)
h5createGroup(h5File,"foo")
B = array(seq(0.1,2.0,by=0.1),dim=c(5,2,2))
h5write(B, h5File,"foo/B")

# reopen file and dataset and get object info
fid <- H5Fopen(h5File)
oid = H5Oopen(fid, "foo")
H5Oget_num_attrs(oid)
H5Oclose(oid)
H5Fclose(fid)

}
\seealso{
\code{\link[=H5Oclose]{H5Oclose()}}
}