RFmxBT_FrequencyRangeFetchSpectrum

RFmx Bluetooth 19.1 Help

Edition Date: October 2019

Part Number: 377889C-01

»View Product Info

DOWNLOAD (Windows Only)


RFmx Bluetooth 19.1 Help
RFmx Bluetooth 20.0 Help

int32 __stdcall RFmxBT_FrequencyRangeFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the FrequencyRange spectrum trace.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start frequency. This value is expressed in Hz.
dx float64* Returns the frequency bin spacing. This value is expressed in Hz.
spectrum float32[] Returns the averaged power measured at each frequency bin. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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