beautypg.com

Cilxs_configureoutputenabled – AMETEK Ls Series Driver Manual User Manual

Page 58

background image

IVI Driver Manual

Lx / Ls Series

54

ciLxs_ConfigureOutputEnabled


ViStatus ciLxs_ConfigureOutputEnabled (ViSession instrumentHandle,
ViBoolean enabled);

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


enabled

Variable Type ViBoolean

Pass whether you want the signal the power supply produces on a
output. The driver uses this value to set the
CILXS_ATTR_OUTPUT_ENABLED attribute.

Valid Values:
VI_TRUE (1) - Enable the output
VI_FALSE (0) - Disable the output

Default Value: VI_TRUE

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

This manual is related to the following products: