Page tree

The license could not be verified: License Certificate has expired!

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

 

JAVA

FORTRAN

C++

C

 

Link

H5E_GET_AUTO2

Returns the settings for the automatic error stack traversal function and its data

Procedure:

H5E_GET_AUTO2(estack_id, func, client_data)

Signature:

herr_t H5Eget_auto2( hid_t estack_id, H5E_auto2_t * func, void **client_data )

Parameters:
hid_t estack_id     IN: Error stack identifier. H5E_DEFAULT indicates the current stack.
H5E_auto2_t * funcOUT: The function currently set to be called upon an error condition.
void **client_data    OUT: Data currently set to be passed to the error function.

Description:

H5Eget_auto2 returns the settings for the automatic error stack traversal function, func, and its data, client_data, that are associated with the error stack specified by estack_id.

Either or both of the func and client_data arguments may be null, in which case the value is not returned.

The library initializes its default error stack traversal functions to H5Eprint1 and H5Eprint2. A call to H5Eget_auto2 returns H5Eprint2 or the user-defined function passed in through H5Eset_auto2. A call to H5Eget_auto1 returns H5Eprint1 or the user-defined function passed in throughH5Eset_auto1. However, if the application passes in a user-defined function through H5Eset_auto1, it should call H5Eget_auto1 to query the traversal function. If the application passes in a user-defined function through H5Eset_auto2, it should call H5Eget_auto2 to query the traversal function.

Mixing the new style and the old style functions will cause a failure. For example, if the application sets a user-defined old-style traversal function through H5Eset_auto1, a call to H5Eget_auto2 will fail and will indicate that the application has mixed H5Eset_auto1 and H5Eget_auto2. On the other hand, mixing H5Eset_auto2 and H5Eget_auto1 will also cause a failure. But if the traversal functions are the library’s default H5Eprint1 or H5Eprint2, mixing H5Eset_auto1 and H5Eget_auto2 or mixing H5Eset_auto2 and H5Eget_auto1 does not fail.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    C
1.8.0Function introduced in this release.

--- Last Modified: April 03, 2018 | 03:11 PM