beautypg.com

Cilxs_configurefrequencyvalue – AMETEK Ls Series Driver Manual User Manual

Page 52

background image

IVI Driver Manual

Lx / Ls Series

48

ciLxs_ConfigureFrequencyValue


ViStatus ciLxs_ConfigureFrequencyValue (ViSession instrumentHandle,
ViReal64 value);

Purpose

This function configures the AC RMS voltage level that the power supply
attempts to generate.

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


value

Variable Type ViReal64

Pass the AC frequency you want the AC source to attempt to generate.
The driver sets the CILXS_ATTR_FREQUENCY attribute to this value.

Units: Hz

Valid Range:
45.0 to 5000.0

Default Value: 50.0 Hz




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
-------------------------------

This manual is related to the following products: