HDF5 Object Interface {rhdf5} | R Documentation

## HDF5 Object Interface

### Description

The Object interface, H5O, functions manipulate objects in an HDF5 file. This interface is designed to be used in conjunction with the Links interface (H5L).

### Usage

    H5Oopen  (h5loc, name)
    H5Oclose (h5obj)
    H5Oget_num_attrs(h5obj)
    H5Oget_num_attrs_by_name(h5loc, name)

### 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.
`h5loc` | An object of class `H5IdComponent` representing a H5 location identifier (file or group). See `H5Fcreate`, `H5Fopen`, `H5Gcreate`, `H5Gopen` to create an object of this kind.
`name` | The name of the link to be checked.

### Details

Interface to the HDF5 C-library libhdf5. See https://portal.hdfgroup.org/display/HDF5/Objects for further details.

### Value

`H5Oopen` opens an object (a file, group, or dataset) and returns an object of class `H5IdComponent`. `H5Oclose` closed the object again. `H5Oget_num_attrs` and `H5Oget_num_attrs_by_name` return the number of attributes of an object.

### Author(s)

Bernd Fischer

### References

https://portal.hdfgroup.org/display/HDF5

### See Also

rhdf5

### Examples

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

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

[Package rhdf5 version 2.36.0 Index]