beautypg.com

Cilxs_configuretriggeredfrequency – AMETEK Ls Series Driver Manual User Manual

Page 88

background image

IVI Driver Manual

Lx / Ls Series

84

ciLxs_ConfigureTriggeredFrequency


ViStatus ciLxs_ConfigureTriggeredFrequency (ViSession instrumentHandle,
ViReal64 triggeredFrequency);

Purpose

This function configures the frequency that the output will be set to
during a triggered step or pulse transient.

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


triggeredFrequency

Variable Type ViReal64

Pass the frequency that the output will be set to during a triggered
step or pulse transient. The driver sets the
CILXS_ATTR_TRIGGERED_FREQUENCY attribute to this value.

Units: hertz

Valid Range:
45.0 to 5000.0

Default Value: 60.0 hertz


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

This manual is related to the following products: