niRFSG_ConfigureIQEnabled [OBSOLETE]

NI-RFSG C Function

niRFSG_ConfigureIQEnabled [OBSOLETE]

C Function Prototype

ViStatus niRFSG_ConfigureIQEnabled (ViSession vi, ViBoolean enabled);

Purpose

Configures the NI-RFSG device to apply IQ (vector) modulation to the RF output signal. IQ modulation must be enabled in order to generate any arbitrary (non-sine) waveform; if IQ modulation is disabled, a sine tone is always generated, regardless if an arbitrary waveform is written. The NI-RFSG device must be in the Configuration state before calling this function.

 Note  This property is obsolete. Use the NIRFSG_ATTR_GENERATION_MODE property to enable IQ modulation instead.

Upon device initialization, or calling the niRFSG_reset function or the niRFSG_ResetDevice function, IQ modulation is disabled.

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

enabled ViBoolean NI-RFSG sets the NIRFSG_ATTR_IQ_ENABLED attribute to this value.

Defined Values:
VI_TRUEEnables IQ (vector) modulation (arbitrary waveform generation)
VI_FALSEDisables IQ (vector) modulation (sine wave generation)


Default Value: VI_FALSE

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