niRFSG_Initiate

NI-RFSG C Function

niRFSG_Initiate

C Function Prototype

ViStatus niRFSG_Initiate (ViSession vi);

Purpose

Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state. If the settings have not been committed to the device before you call this function, they are committed with this function. The operation returns when the RF output signal settles.

To return to the Configuration state, call the niRFSG_Abort function.

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

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