AMETEK Ls Series Driver Manual - Manual (Page 90)

IVI Driver Manual Lx / Ls Series
86
ciLxs_ConfigureTriggeredFrequencyMode
ViStatus ciLxs_ConfigureTriggeredFrequencyMode
(ViSession instrumentHandle, ViInt32 transientMode);
Purpose
This function configures the output frequency controlled during a
triggered output 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
transientMode
Variable Type ViInt32
Specifies how the output frequency is controlled during a triggered
output transient. The driver sets the
CILXS_ATTR_TRIGGERED_FREQUENCY_MODE attribute to this value.
Valid Values:
- CILXS_VAL_TRIGGER_MODE_FIX - The output frequency is unaffected by
a triggered output transient.
- CILXS_VAL_TRIGGER_MODE_STEP - The output frequency is programmed to
the value set by ciLxs_ConfigureTriggeredFrequency when a triggered
transient occurs.
- CILXS_VAL_TRIGGER_MODE_PULSE - The output frequency is changed to
the value set by ciLxs_ConfigureTriggeredFrequency for a duration
determined by the ciLxs_ConfigurePulse function.
- CILXS_VAL_TRIGGER_MODE_LIST - The output frequency is controlled by
the frequency list when a triggered transient occurs.
Default Value:
CILXS_VAL_TRIGGER_MODE_FIX
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