Closes the RFmx session.

Syntax

int32 __stdcall RFmxInstr_Close(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 forceDestroy)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

selectorString[in]char[]

Specifies a selector string. Pass an empty string.

forceDestroy[in]int32

This parameter indicates whether to forcefully destroy the RFmx session.

The default value is FALSE.

Name (value)

Description

TRUE

Forcefully destroys the RFmx session. You do not have to call the RFmxInstr Close function multiple times. Destroying the RFmx session invalidates all references to the session.

FALSE

Destroys the RFmx session only if you call the RFmxInstr Close function a number of times equal to the number of times you obtained a reference to the RFmx 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 RFmxInstr_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors