Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

niWLANG_RFSGRetrieveBurstStartLocations

NI WLAN Generation Toolkit 17.0 Help

Edition Date: May 2017

Part Number: 373725G-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niWLANG_RFSGRetrieveBurstStartLocations (ViSession rfsgSession, char waveformName[], int32 burstStartLocations[], int32 dataArraySize, int32* actualDataArraySize);

Purpose

Returns the burst start locations stored in the RFSG database.

Parameters

Input
Name Type Description
rfsgSessions ViSession[] Specifies a reference to an NI-RFSG instrument session. This parameter is obtained from the niRFSG_init or niRFSG_InitWithOptions functions and identifies a particular instrument session.
waveformName char[] Specifies the name of the waveform for which you want to retrieve the burst start locations. The toolkit uses this parameter as the key to retrieve the waveform properties in the RFSG database.
dataArraySize int32 Specifies the number of elements in the burstStartLocations array.
Output
Name Type Description
burstStartLocations int32[] Returns the burst start locations stored, for the waveform you specified in the waveformName parameter. It is an array of sample positions at 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

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit