niRFSGPlayback_RetrieveWaveformRFBlankingMarkerLocations

NI-RFSG Playback Library 3.0 Help

Edition Date: January 2019

Part Number: 375551E-01

»View Product Info
Download Help (Windows Only)

ViStatus __stdcall niRFSGPlayback_RetrieveWaveformRFBlankingMarkerLocations (ViSession rfsgSession, ViConstString waveformName, ViInt32 markerLocationsSize, ViInt32 markerLocations[], ViInt32 *actualNumberOfLocations);

Purpose

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

Parameters

Input
Name Type Description
rfsgSession ViSession Identifies the instrument session. rfsgSession is obtained from either the niRFSG_init function or the niRFSG_InitWithOptions function.
waveformName ViConstString Specifies the waveform name for which you want to retrieve the RF blanking marker locations.
markerLocationsSize ViInt32 Specifies the size of the markerLocations array. Set the markerLocationsSize parameter to 0 to get the size of the markerLocations array in the actualNumberOfLocations parameter.
Output
Name Type Description
markerLocations ViInt32[] Returns the array of RF blanking marker positions, stored in the NI-RFSG waveform database for the waveform you specified in the waveformName parameter.
actualNumberOfLocations ViInt32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the markerLocationsSize parameter to 0.

Return Value

Name Type Description
status ViStatus 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

WAS THIS ARTICLE HELPFUL?

Not Helpful