niWLANG_ReadBurstStartLocationsFromFile

NI WLAN Generation Toolkit 18.0 Help

Edition Date: October 2018

Part Number: 373725J-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niWLANG_ReadBurstStartLocationsFromFile (char filePath[], char channelString[], int32 burstStartLocations[], int32 dataArraySize, int32 *actualDataArraySize);

Purpose

Reads the burst start locations from a TDMS file. You can save this file using the NI WLAN Generation Soft Front Panel or the niWLANG_CreateandWriteWaveformstoFile function in a programming environment.

Parameters

Input
Name Type Description
filePath char[] Specifies the absolute path to the TDMS file from which the toolkit reads the waveform.
channelString char[] Set this parameter to "" (empty string) or NULL.
dataArraySize int32 Specifies the number of elements in the burstStartLocations array.
Output
Name Type Description
burstStartLocations int32[] Returns the burst start locations saved in the TDMS file. It is an array of sample positions of the start of the burst, within the waveform.
actualDataArraySize int32* Returns the actual number of elements populated in the burstStartLocations array parameter. If the array is not large enough to hold all the samples, the function returns an error and actualDataArraySize 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 condition. Examine the status code from each call to the function to determine if an error occurred.

To obtain a text description of the status code, call the niWLANG_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