niRFSG_reset

NI-RFSG C Function

niRFSG_reset

C Function Prototype

ViStatus niRFSG_reset (ViSession vi);

Purpose

Resets all attributes to their default values and moves the NI-RFSG device to the Configuration state. This function aborts the generation, clears all routes, and resets session attributes to the initial values. During a reset, routes of signals between this and other devices are released, regardless of which device created the route.

Generally, calling this function instead of the niRFSG_ResetDevice function is acceptable. The niRFSG_reset function executes faster than the niRFSG_ResetDevice function.

Supported Devices: NI 5610 (upconverter only mode), NI 5650/5651/5652/5671/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