niFgen_ClearError
ViStatus niFgen_ClearError (ViSession vi);
Purpose
Clears the error information for the current execution thread and the IVI session you specify. If you pass VI_NULL for the vi parameter, this function clears the error information only for the current execution thread.
This function sets the error code to VI_SUCCESS (0), and sets the error description string to "" (empty string) .
The IVI Engine also maintains this error information separately for each thread. This feature is useful if you do not have a session handle to pass to the niFgen_ClearError or the niFgen_GetError function, which occurs when a call to the niFgen_init or the niFgen_InitWithOptions function fails.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|