niBTSA_DEVMGetCurrentIterationBlockFrequencyErrorTrace

NI Bluetooth Analysis Toolkit 19.1 Help

Edition Date: October 2019

Part Number: 373431L-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niBTSA_DEVMGetCurrentIterationBlockFrequencyErrorTrace (niBTSASession session, char channelString[], float64 *x0, float64 *dx, float64 freqErrorTrace[], int32 dataArraySize, int32 *actualArraySize);

Purpose

Returns the block frequency error trace for the current iteration.

Parameters

Input
Name Type Description
session niBTSASession Specifies the niBT SA session. Use this parameter to configure the behavior and operation of the appropriate NI Bluetooth Analysis Toolkit function that accepts the niBTSASession as an input.
channelString char[] Set this parameter to "" (empty string) or NULL.
dataArraySize int32 Specifies the size of the freqErrorTrace array.
Output
Name Type Description
x0 float64* Returns the starting block index. This value is set to 0.
dx float64* Returns the block interval. This value is set to 1.
freqErrorTrace float64[] Returns the array of block frequency error measurements, as a percentage, of the signal. The toolkit calculates the block frequency error measurements over multiple non-overlapping 50 symbol blocks. The toolkit performs this measurement on the enhanced data rate (EDR) portion of the packet excluding the trailer symbols.
actualArraySize int32* Returns the actual number of elements populated in the freqErrorTrace array. If the array is not large enough to hold all the samples, the function returns an error and the actualArraySize parameter returns the minimum expected size of the output array.

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. Examine the status code from each call to an niBT SA 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 niBTSA_GetErrorString 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