RFmxInstr_ResetDriver

NI-RFmx GSM 2.5 Help

Edition Date: June 2018

Part Number: 375416F-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall RFmxInstr_ResetDriver (niRFmxInstrHandle instrumentHandle);

Purpose

Restores the NI-RFSA driver state to a default state to avoid RFmx using any hardware or driver state that was set by the RF toolkits or other custom NI-RFSA code.

Use this function when you switch back to using RFmx to perform measurements after you have used the NI-RFSA handle to perform measurements with RF toolkits or you have used other custom NI-RFSA code. Unlike the RFmxInstr_ResetToDefault function, the RfmxInstr_ResetDriver function does not reset RFmx attributes configured on the RFmx session. Hence, you do not need to set RFmx attributes again when switching back to RFmx measurements.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxInstr_Initialize function.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxInstr_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful