AMETEK Ls Series Driver Manual - Manual (Page 216)

IVI Driver Manual Lx / Ls Series
212
ciLxs_QueryMaxCurrentLimit
ViStatus ciLxs_QueryMaxCurrentLimit (ViSession instrumentHandle,
ViPReal64 maxCurrentLimit);
Purpose
This function returns the maximum programmable current limit that the
power supply accepts for a particular voltage level on a phase for the
output range to which the power supply is currently configured.
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
maxCurrentLimit
Variable Type ViReal64 (passed by reference)
This parameter returns the maximum programmable current limit of the
AC source.
Units: amps (A)
Note:
1) This value is valid only for sine function.
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
Positive Values Warnings