GtWaveSetAmState

Supported By

GX110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Sets the AM modulation state.

Syntax

GtWaveSetAmState (nHandle, nChannel, bState, 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.
bState
BOOL
AM modulation state:
0.        Disabled.
1.        Enabled
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example enables the AM modulation:

 

BOOL bState;

GtWaveSetAmState (nHandle, GTWAVE_CHANNEL_A, TRUE, &nStatus);

 

See Also

GtWaveSetAmDepth, GtWaveSetAmFrequency, GtWaveSetAmSource, GtWaveGetAmState, GtWaveGetAmWaveform, GtWaveGetErrorString