niRFSG_ConfigureOutputEnabled

NI-RFSG C Function

niRFSG_ConfigureOutputEnabled

C Function Prototype

ViStatus niRFSG_ConfigureOutputEnabled (ViSession vi, ViBoolean output_enabled);

Purpose

Enables or disables signal output. You can call this function in any software state, and it does not change the current software state. Setting output_enabled to VI_FALSE while in the Generation state stops signal generation, although generation continues internally.

Supported Devices: NI 5610 (upconverter only mode), 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_enabled ViBoolean Specifies whether you want to enable or disable the output.

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