RFmxGSM_Close

RFmx GSM 19.1 Help

Edition Date: October 2019

Part Number: 375414H-01

»View Product Info

DOWNLOAD (Windows Only)


RFmx GSM 19.1 Help
RFmx GSM 20.0 Help

int32 __stdcall RFmxGSM_Close (niRFmxInstrHandle instrumentHandle, int32 forceDestroy);

Purpose

Closes the RFmx session.

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

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxGSM_Initialize function.
forceDestroy int32 Specifies whether to destroy the RFmx session.

RFMXGSM_VAL_FALSE (0) Destroys the RFmx session. Call the RFmxGSM_Close function a number of times equal to the number of times you obtained a reference to the RFmx session.
RFMXGSM_VAL_TRUE (1) Destroys the RFmx session. You do not have to call the RFmxGSM_Close function multiple times. Destroying the RFmx session invalidates all references to the session.

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 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 RFmxGSM_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