beautypg.com

Cilxs_configureoutputalcstate – AMETEK Ls Series Driver Manual User Manual

Page 56

background image

IVI Driver Manual

Lx / Ls Series

52

ciLxs_ConfigureOutputALCState


ViStatus ciLxs_ConfigureOutputALCState (ViSession instrumentHandle,
ViInt32 ALCState);

Purpose

This function enables or disables the AC source output. The state of a
disabled output is an output voltage amplitude set to 0 volts, with
output relays opened.

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


ALCState

Variable Type ViInt32

Pass whether you want to enable the ALC on the AC source. The driver
uses this value to set the CILXS_ATTR_OUTPUT_ALC_STATE attribute.

Valid Values:
CILXS_ALC_OFF (0) - Disable ALC on the output
CILXS_ALC_ON (1) - Enable ALC on the output(output will
fault if output voltage is far apart
from programmed value)
CILXS_ALC_REGULATE (2) - Enable ALC on the output(output will
NOT fault if output voltage is far
apart from programmed value)

Default Value: CILXS_ALC_REGULATE

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:

This manual is related to the following products: