AMETEK Ls Series Driver Manual - Manual (Page 47)

IVI Driver Manual Lx / Ls Series
43
ciLxs_ConfigureClippingLevel
ViStatus ciLxs_ConfigureClippingLevel (ViSession instrumentHandle,
ViReal64 clippingLevel);
Purpose
This function configures the clipping level when a cliped sine output
waveform is selected.
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
clippingLevel
Variable Type ViReal64
Pass the clipping level when a cliped sine output waveform is
selected. The driver sets the CILXS_ATTR_CLIPPING_LEVEL attribute to
this value.
Units: percentage
Valid THD Range: 0.0% to 43.0%(1.5 to 100.0 clip level)
Default Value: 0.0%
Note:
(1) This parameter is ignored when function CILXS_VAL_CLIPPED_SINE
("CSINUSOID") is not selected.
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: