niFgen_ClearUserStandardWaveform

NI-FGEN C Function

niFgen_ClearUserStandardWaveform

ViStatus niFgen_ClearUserStandardWaveform (ViSession vi, ViConstString channelName);

Purpose

Clears the user-defined waveform created by the niFgen_DefineUserStandardWaveform function.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session.
channelName ViConstString Specifies the channel name from which you want to clear a user standard waveform.

Default Value: "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. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred. To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors