beautypg.com

Cilxs_configureacquisitionstarttime – AMETEK Ls Series Driver Manual User Manual

Page 45

background image

IVI Driver Manual

Lx / Ls Series

41

ciLxs_ConfigureAcquisitionStartTime


ViStatus ciLxs_ConfigureAcquisitionStartTime (ViSession instrumentHandle,
ViReal64 startTime);

Purpose

This function configures the length of time from the acquire trigger
event to the first point in the record.

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


startTime

Variable Type ViReal64

Specifies the length of time from the acquire trigger event to the
first point in the record. If the value is positive, the first point
in the record occurs after the acquire trigger event. If the value
is negative, the first point in the record occurs before the acquire
trigger event. The driver sets the CILXS_ATTR_ACQUISITION_START_TIME
to this value.

Units: seconds

Valid Range:
Range depends on the CILXS_ATTR_ACQUISITION_TIME_INTERVAL attribute.
Following formula is valid.

min = -4095 * CILXS_ATTR_ACQUISITION_TIME_INTERVAL
max = 2e9 * CILXS_ATTR_ACQUISITION_TIME_INTERVAL

Default Value: 0.0

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.

This manual is related to the following products: