GtWaveGetAmState

Supported By

GX1110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Returns the AM modulation state.

Syntax

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

Example

The following example returns the AM modulation state:

 

BOOL bState;

GtWaveGetAmState (nHandle, GTWAVE_CHANNEL_A, &bState, &nStatus);

 

See Also

GtWaveSetAmDepth, GtWaveSetAmFrequency, GtWaveSetAmSource, GtWaveSetAmState, GtWaveSetAmWaveform, GtWaveGetErrorString