Returns the RF blanking marker positions stored in the NI-RFSG database. This function uses the waveformName as the key to retrieve the waveform property.

Syntax

int32 __stdcall niRFSGPlayback_ReadBurstStopLocationsFromFile(ViConstString filePath, ViInt32 waveformIndex, ViInt32 burstStopLocationsSize, ViInt32[] burstStopLocations, ViInt32 actualNumberOfLocations)

Parameters

NameDirectionTypeDescription
filePath[in]ViConstString

Specifies the absolute path to the TDMS file from which the playback library reads the waveforms.

waveformIndex[in]ViInt32

Specifies the waveform name for which you want to retrieve the burst stop locations.

burstStopLocationsSize[in]ViInt32

Specifies the size of the burstStopLocations array. Set the burstStopLocationsSize parameter to 0 to get the size of the burstStartLocations array in the actualNumberOfLocations parameter.

burstStopLocations[out]ViInt32[]

Returns an array of the burst stop locations, stored in the file for the waveform number which you specified in the waveformIndex parameter.

actualNumberOfLocations[out]ViInt32

Returns the actual size of the array, if you pass NULL to all output array parameters, and set the burstStopLocationsSize parameter to 0.

Returns

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 niRFSGPlayback_GetError function. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors