Cilxs_configureoutputphasemode – AMETEK Ls Series Driver Manual User Manual
Page 60

IVI Driver Manual
Lx / Ls Series
56
ciLxs_ConfigureOutputPhaseMode
ViStatus ciLxs_ConfigureOutputPhaseMode (ViSession instrumentHandle,
ViInt32 phaseMode);
Purpose
This function selects the output phase mode for three phase systems.
Available options are single or three phase mode. In three phase mode,
the phase coupling can be set to COUPLED or UNCOUPLED.
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
phaseMode
Variable Type ViInt32
Specifies the number of output phases for ac sources that have
single-phase and three-phase switchable capability. The driver uses
this value to set the CILXS_ATTR_OUTPUT_PHASE_COUNT attribute.
Valid Values:
CILXS_VAL_1_PHASE - Single phase mode
CILXS_VAL_3_PHASE - Three phase mode
Default Value: CILXS_VAL_1_PHASE
Note:
1) When number of phase is changed, driver waits 15 seconds.
Instrument requires this time for changing output phase.
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: