GtWaveGetAmWaveform

Supported By

GX1110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Returns the AM modulation waveform.

Syntax

GtWaveGetAmWaveform (nHandle, nChannel, pnWaveform, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX11X0 board.
nChannel
SHORT
Specified Channel number.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
1 = GTWAVE_CHANNEL_B: Channel B.
pnWaveform
PSHORT
Standard waveform can be one of the following:
0.        GTWAVE_WAVEFORM_SINE: Sinusoidal waveform.
1.        GTWAVE_WAVEFORM_SQUARE: Square waveform.
2.        GTWAVE_WAVEFORM_TRIANGLE: Triangular waveform.
3.        GTWAVE_WAVEFORM_RAMP_UP: Positive ramp waveform
4.        GTWAVE_WAVEFORM_RAMP_DOWN: Negative ramp waveform
5.        GTWAVE_WAVEFORM_RAMP_DC: Constant voltage
6.        GTWAVE_WAVEFORM_NOISE: White noise
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example Returns the AM modulation waveform:

 

SHORT nWaveform;

GtWaveGetAmWaveform (nHandle, GTWAVE_CHANNEL_A, &nWaveform, &nStatus);

 

See Also

GtWaveSetAmWaveform, GtWaveSetAmDepth, GtWaveSetAmFrequency, GtWaveSetAmSource, GtWaveGetAmState, GtWaveGetErrorString