AMETEK Ls Series Driver Manual - Manual (Page 35)

IVI Driver Manual Lx / Ls Series
31
ciLxs_ClearArbWaveforms
ViStatus ciLxs_ClearArbWaveforms (ViSession instrumentHandle,
ViString waveformName);
Purpose
This function deletes individual user-defined waveforms.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or
ciLxs_InitWithOptions function. The handle identifies a particular
instrument session.
Default Value: None
waveformName
Variable Type ViString
This control specifies the name of the waveform to be defined.
Valid Range:
String with less than 15 characters.
Default Value: "ArbWave"
Notes:
The Waveform Name will be truncated if it exceeds 15 characters.
Return Value
Returns the status code of this operation. The status code either
indicates success or describes an error or warning condition. You
examine the status code from each call to an instrument driver
function to determine if an error occurred.
To obtain a text description of the status code, call the
ciLxs_error_message function. To obtain additional information about
the error condition, call the ciLxs_GetError function. To clear the
error information from the driver, call the ciLxs_ClearError
function.
The general meaning of the status code is as follows:
Value Meaning
-------------------------------
0 Success