NI-RFSG Playback Library

niRFSGPlayback_ReadRFBlankingMarkerSourceFromFile

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus __stdcall niRFSGPlayback_ReadRFBlankingMarkerSourceFromFile (ViConstString filePath, ViInt32 waveformIndex, ViInt32 markerSourceSize, ViChar markerSource[]);

Purpose

Returns the RF blanking marker source stored in the file. This function uses the waveformIndex as the key to retrieve the waveform property.

Parameters

Input
Name Type Description
filePath ViConstString Specifies the absolute path to the TDMS file from which the playback library reads the waveforms.
waveformIndex ViInt32 Specifies the waveform number in the file for which you want to read the RF blanking marker source.
markerSourceSize ViInt32 Specifies the size of the array in the markerSource parameter.
Output
Name Type Description
markerSource ViChar[] Returns the RF blanking marker source value, stored in the file for the waveform number which you specified in the waveformIndex parameter.

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

Log in to get a better experience