File: H5Acreate.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 (30 lines) | stat: -rw-r--r-- 1,414 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/H5A.R
\name{H5Acreate}
\alias{H5Acreate}
\title{Create an attribute for an HDF5 object}
\usage{
H5Acreate(h5obj, name, dtype_id, h5space)
}
\arguments{
\item{h5obj}{An object of class \linkS4class{H5IdComponent} representing a H5 object
identifier (file, group, or dataset). See \code{\link[=H5Fcreate]{H5Fcreate()}}, \code{\link[=H5Fopen]{H5Fopen()}},
\code{\link[=H5Gcreate]{H5Gcreate()}}, \code{\link[=H5Gopen]{H5Gopen()}}, \code{\link[=H5Dcreate]{H5Dcreate()}}, or \code{\link[=H5Dopen]{H5Dopen()}} to create an object of this kind.}

\item{name}{The name of the attribute (character).}

\item{dtype_id}{A character name of a datatype. See \code{h5const("H5T")} for
possible datatypes. Can also be an integer representing an HDF5 datatype.
Only simple datatypes are allowed for attributes.}

\item{h5space}{An object of class \linkS4class{H5IdComponent} representing a H5
dataspace. See \code{\link[=H5Dget_space]{H5Dget_space()}}, \code{\link[=H5Screate_simple]{H5Screate_simple()}}, \code{\link[=H5Screate]{H5Screate()}} to create an object
of this kind.}
}
\value{
An object of class \linkS4class{H5IdComponent} representing a H5 attribute identifier.
}
\description{
Creates an attribute, \code{name}, which is attached to the object specified
by the identifier \code{h5obj}. The attribute name must be unique for the object.
}