Clears the specified error stack or the error stack for the current thread

Procedure:

H5E_CLEAR2(estack_id)

Signature:

<pre><code class="language-c">herr_t H5Eclear2(hid_t estack_id)</code></pre>

<pre><code class="language-fortran">SUBROUTINE h5eclear_f(hdferr) 
  IMPLICIT NONE 
  INTEGER, INTENT(OUT) :: hdferr  ! Error code 

END SUBROUTINE h5eclear_f</code></pre>

Parameters:
hid_t estack_id    IN: Error stack identifier

Description:

H5E_CLEAR2 clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the error stack for the current thread.

estack_id is an error stack identifier, such as that returned by H5E_GET_CURRENT_STACK.

The current error stack is also cleared whenever an API function is called, with certain exceptions (for instance, H5E_PRINT1 or H5E_PRINT2).

Returns:

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

Example:

Fortran example coming soon!

History:
Release    C
1.8.0Function introduced in this release.