Skip to main content

HDF5DumpErrors

HDF5DumpErrors [ /CLR=clear /Q ]

The HDF5DumpErrors operation dumps information about HDF5 library errors encountered by Igor. This information, which will make sense mostly to HDF5 experts, may help debug difficult problems. It is not needed in most cases.

When the HDF5 library returns an error to Igor, Igor stores a general description of the error and further information provided by the HDF5 library's H5E interface. This information is dumped by HDF5DumpErrors.

Starting with Igor Pro 9.00, if you include the /Z flag with an HDF5 operation, errors are not recorded for dumping by HDF5DumpErrors.

Flags

/QIf /Q is omitted, then the output is dumped to Igor's history area and to the S_HDF5ErrorInfo variable. If /Q is present, then output is dumped only to the S_HDF5ErrorInfo variable.
/CLR=clear
clear =0:The error information is not cleared after the dump. This is the default behavior.
clear =1:The error information is cleared after the dump.

Output Variables

HDF5DumpErrors sets the following output variables:

V_FlagSet to zero if the operation succeeds, non-zero if it fails.
S_HDF5ErrorInfoSet to the dump text.