niRFSGPlayback_ClearWaveform

NI-RFSG Playback Library 19.1 Help

Edition Date: October 2019

Part Number: 375551G-01

»View Product Info

Download Help (Windows Only)


NI-RFSG Playback Library 19.1 Help
NI-RFSG Playback Library 20.0 Help

ViStatus __stdcall niRFSGPlayback_ClearWaveform (ViSession rfsgSession, ViConstString waveformName);

Purpose

Deletes the waveform from NI-RFSG device memory and removes the waveform property from the NI-RFSG waveform database for the specified device.

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 to be deleted from the database.

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