beautypg.com

Cilxs_self_test – AMETEK Ls Series Driver Manual User Manual

Page 237

background image

IVI Driver Manual

Lx / Ls Series

233

ciLxs_self_test


ViStatus ciLxs_self_test (ViSession instrumentHandle,
ViPInt16 selfTestResult,
ViChar _VI_FAR selfTestMessage[]);

Purpose

This function runs the instrument's self test routine and returns the
test result(s).



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


selfTestResult

Variable Type ViInt16 (passed by reference)

This control contains the value returned from the instrument self
test. Zero means success. For any other code, see the device's
operator's manual.

Self-Test Code Description
---------------------------------------
0 Passed self test
1 Self test failed



selfTestMessage

Variable Type ViChar[]

Returns the self-test response string from the instrument. See the
device's operation manual for an explanation of the string's
contents.

You must pass a ViChar array with at least 256 bytes.

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.

This manual is related to the following products: