RFmxGSM_Initiate

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_Initiate (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultName[]);

Purpose

Initiates all enabled measurements. Call this function after configuring the signal and measurement. This function asynchronously launches measurements in the background and immediately returns to the caller program. You can fetch measurement results using the Fetch functions or result attributes in the attribute node. To get the status of measurements, use the RFmxGSM_WaitforMeasurementComplete function or RFmxGSM_CheckMeasurementStatus function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxGSM_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. The result name can either be specified through this input or the resultName parameter. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name in this parameter, either the result name specified by the resultName parameter or the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxGSM_BuildSignalString function to build the selector string.
resultName char[] Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix.
Example:
""
"result::r1"
"r1"

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