niFgen_reset
ViStatus niFgen_Reset (ViSession vi);
Purpose
Resets the instrument to a known state. This function aborts the generation, clears all
routes, and resets session attributes to the default values. This function does not,
however, commit the session properties or configure the device hardware to its default
state.
 |
Note For the NI 5401/5404/5411/5431, this function exhibits the
same behavior as the niFgen_ResetDevice function. |
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:
| Value |
Meaning |
| 0 |
Success |
| Positive Values |
Warnings |
| Negative Values |
Errors |
|