niFgen_GetHardwareState
ViStatus niFgen_GetHardwareState (ViSession vi, ViInt32* state);
Purpose
Returns the current hardware state of the device and, if the device is in the hardware error state, the current hardware error.
 |
Note Hardware states do not necessarily correspond to NI-FGEN states. |
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. |
| Output |
| Name |
Type |
Description |
| state |
ViInt32* |
Returns the Hardware state of the signal generator. Defined Values
| NIFGEN_VAL_IDLE |
The device is in the Idle state. |
| NIFGEN_VAL_WAITING_FOR_START_TRIGGER |
The device is waiting for Start trigger. |
| NIFGEN_VAL_RUNNING |
The device is in the Running state. |
| NIFGEN_VAL_DONE |
The generation has completed successfully. |
| NIFGEN_VAL_HARDWARE_ERROR |
There is a hardware error. |
|
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 |
|