H5Gget_info: Retrieve information about a group

In grimbough/rhdf5: R Interface to HDF5

Retrieve information about a group

Description

Retrieve information about a group

Usage

H5Gget_info(h5loc)

H5Gget_info_by_name(h5loc, group_name)

H5Gget_info_by_idx(
  h5loc,
  n,
  group_name = ".",
  index_type = h5default("H5_INDEX"),
  order = h5default("H5_ITER")
)

Arguments

h5loc	An object of class H5IdComponent representing a H5 group.
group_name	An additional group name specifying the group for which information is sought. It is interpreted relative to h5loc.
n	Position in the index of the group for which information is retrieved.
index_type	See h5const("H5_INDEX") for possible arguments.
order	See h5const("H5_ITER") for possible arguments.

Value

A list with group information

Examples

h5file <- system.file("testfiles", "multiple_dtypes.h5", package="rhdf5")
fid <- H5Fopen(h5file)
gid <- H5Gopen(fid, "/foo")
gid
H5Gget_info(gid)
H5Gclose(gid)

## the "get_info_by" functions take the H5 object that contains the
## group(s) of interest.  We can retrieve information by index or by name
H5Gget_info_by_idx(fid, 3)
H5Gget_info_by_name(fid,"/foo")

H5Fclose(fid)

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