hdf5info (MATLAB Functions)

Return information about an HDF5 file

Syntax

fileinfo = hdf5info(filename)
fileinfo = hdf5info(filename,'ReadAttributes',BOOL)

Description

S = hdf5info(filename) returns a structure fileinfo whose fields contain information about the contents of the HDF5 file filename. filename is a string that specifies the name of the HDF5 file.

S = hdf5info(...,'ReadAttributes',BOOL) specifies whether hdf5info returns the values of the attributes or just information describing the attributes. By default, hdf5info reads in attribute values (BOOL = true).

Examples

To find out about the contents of the HDF5 file, look at the GroupHierarchy field returned by hdf5info.

fileinfo = hdf5info('example.h5')

fileinfo = 

          Filename: 'example.h5'
        LibVersion: '1.4.5'
            Offset: 0
          FileSize: 8172
    GroupHierarchy: [1x1 struct]

To probe further into the hierarchy, keep examining the Groups field.

toplevel = fileinfo.GroupHierarchy

toplevel = 

      Filename: [1x64 char]
          Name: '/'
        Groups: [1x2 struct]
      Datasets: []
     Datatypes: []
         Links: []
    Attributes: [1x2 struct]

See also

hdf5read, hdf5write, hdfinfo

hdf5 hdf5read