niRFSG_CheckGenerationStatus

NI-RFSG C Function

niRFSG_CheckGenerationStatus

C Function Prototype

ViStatus niRFSG_CheckGenerationStatus (ViSession vi, ViBoolean* isDone);

Purpose

Checks the status of the generation. Call this function to check for any errors that might occur during the signal generation or to check whether the device has finished generating.

Supported Devices: NI 5650/5651/5652/5670/5671/5672

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.

Default Value: None

Output
Name Type Description
isDone ViBoolean* Returns information about the completion of signal generation.

Defined Values:
VI_TRUESignal generation is complete.
VI_FALSE Signal generation is occurring.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred.

To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors