niRFSG_ConfigureGenerationMode

NI-RFSG C Function

niRFSG_ConfigureGenerationMode

Specific Function

C Function Prototype

ViStatus niRFSG_ConfigureGenerationMode (ViSession vi, ViInt32 generationMode);

Purpose

Configures the NI-RFSG device to generate a continuous wave (CW) sine tone, apply IQ (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. The NI-RFSG device must be in the Configuration state before calling this 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

generationMode ViInt32 Specifies the mode used by NI-RFSG to generate an RF output signal. NI-RFSG sets the NIRFSG_ATTR_GENERATION_MODE attribute to this value.

After initializing the NI RF signal generator or calling the niRFSG_reset or niRFSG_ResetDevice functions, this parameter is set to NIRFSG_VAL_CW.

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