Closes the session to the device.

Syntax

int32 __stdcall RFmxBT_Close(niRFmxInstrHandle instrumentHandle, int32 forceDestroy)

Remarks

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_Close function.

Note

Enabling the SFP (Soft Front Panel) debug has a performance impact. For best performance, NI recommends disabling SFP debug. SFP debug can be enabled/disabled from either the RF Signal Analyzer panel in InstrumentStudio, the RFSA Soft Front Panel, or the RFmx Debug Configuration Utility.

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

Identifies the RFmx session. You can obtain this parameter from the RFmxBT_Initialize function.

forceDestroy[in]int32

Specifies whether to destroy the RFmx session.

Value

Description

RFMXBT_VAL_FALSE (0)

Destroys the RFmx session. Call the RFmxBT_Close function a number of times equal to the number of times you obtained a reference to the RFmx session.

RFMXBT_VAL_TRUE (1)

Destroys the RFmx session. You do not have to call the RFmxBT_Close function multiple times. Destroying the RFmx session invalidates all references to the session.

Returns

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 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 RFmxBT_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors