niRFSG_ConfigureRF

NI-RFSG C Function

niRFSG_ConfigureRF

C Function Prototype

ViStatus niRFSG_ConfigureRF (ViSession vi, ViReal64 frequency, ViReal64 powerLevel);

Purpose

Configures the frequency and power level of the RF output signal. 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

frequency ViReal64 Specifies the frequency of the generated RF signal. For arbitrary waveform generation, this parameter specifies, in Hz, the center frequency of the signal. NI-RFSG sets the NIRFSG_ATTR_FREQUENCY attribute to this value. Refer to the specifications document that shipped with your device for allowable frequency settings.

powerLevel ViReal64 Specifies the power level of the generated RF signal, expressed in dBm. By default, this parameter specifies the average power of the signal. To configure the power level of a waveform with varying power content, set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.

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