beautypg.com

Cilxs_querydefinedwaveforms – AMETEK Ls Series Driver Manual User Manual

Page 214

background image

IVI Driver Manual

Lx / Ls Series

210

ciLxs_QueryDefinedWaveforms


ViStatus ciLxs_QueryDefinedWaveforms (ViSession instrumentHandle,
ViChar _VI_FAR definedWaveforms[]);

Purpose

This function queries for a list of the defined waveform names.

Notes:

The list includes both pre-defined waveforms such as SINUSOID, SQUARE,
and CSINUSOID, as well as any user-defined waveforms.

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


definedWaveforms

Variable Type ViChar[]

This control displays the list of defined waveform names.

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
Positive Values Warnings
Negative Values Errors

This driver defines the following status codes:

This manual is related to the following products: