ClassPrefix_ClearError
IVI Inherent Function
To form the ClassPrefix_ of the function name, use the prefix of the class driver with which you are working. For example, if you are working with the IviDmm class driver, use the prefix IviDmm_ to create the correct function name, IviDmm_ClearError.
C Function Prototype
ViStatus ClassPrefix_ClearError (ViSession vi)
Purpose
This function clears the error code and error description for the IVI session. If you specify a valid IVI session for the vi parameter, this function clears the error information for the session. If you pass VI_NULL for the vi parameter, this function clears the error information for the current execution thread. If the vi parameter is an invalid session, the function does nothing and returns an error.
The function clears the error code by setting it to VI_SUCCESS. If the error description string is non-NULL, the function de-allocates the error description string and sets the address to VI_NULL.
Parameter
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The instrument handle that you obtain from the ClassPrefix_init or ClassPrefix_InitWithOptions functions. The handle identifies a particular IVI session. You can pass VI_NULL. |