H5Aopen: Open an attribute for an HDF5 object

View source: R/H5A.R

H5AopenR Documentation

Open an attribute for an HDF5 object

Description

Open an attribute for an HDF5 object

Usage

H5Aopen(h5obj, name)

H5Aopen_by_name(h5obj, objname = ".", name)

H5Aopen_by_idx(
  h5obj,
  n,
  objname = ".",
  index_type = h5default("H5_INDEX"),
  order = h5default("H5_ITER")
)

Arguments

h5obj

An object of class H5IdComponent representing a H5 object identifier (file, group, or dataset). See H5Fcreate(), H5Fopen(), H5Gcreate(), H5Gopen(), H5Dcreate(), or H5Dopen() to create an object of this kind.

name

The name of the attribute (character).

objname

The name of the object the attribute belongs to.

n

Opens attribute number n in the given order and index. Indexing is C-style, base-0, so the first attribute is opened with n=0.

index_type

See h5const("H5_INDEX") for possible arguments.

order

See h5const("H5_ITER") for possible arguments.

Value

An object of class H5IdComponent representing a H5 attribute identifier.


grimbough/rhdf5 documentation built on April 16, 2024, 8:22 p.m.