AMETEK Ls Series Driver Manual - Manual (Page 49)

IVI Driver Manual Lx / Ls Series
45
ciLxs_ConfigureCurrentLimit
ViStatus ciLxs_ConfigureCurrentLimit (ViSession instrumentHandle,
ViChar _VI_FAR phase[],
ViInt32 behavior, ViReal64 limit);
Purpose
This function configures the current limit. You specify the output
current limit value and the behavior of the power supply when the output
current is greater than or equal to that value.
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
phase
Variable Type ViChar[]
Pass the virtual phase name that you assign to the instrument in the
Configuration Utility.
Virtual phase names are aliases for instrument-specific phase
strings. The instrument-specific phase strings can differ from one
instrument to another. Virtual phase names allow you to use and swap
instruments without having to change the phase names in your source
code. You assign a virtual phase name to an instrument-specific
phase through the Configuration Utility. This control accepts
virtual phase names you have assigned to the specific instrument you
are using. It also accepts the instrument-specific phase names.
Default Value: ""
Notes:
(1) You can specify the phase name as a string variable or as a
literal enclosed in double quotes.
behavior
Variable Type ViInt32
Pass the behavior you want the power supply to exhibit when the
ouptut current is greater than or equal to the value of the limit
parameter on the specified phase. The driver uses this value to set