GtWaveGetAmDepth

Supported By

GX1110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Returns the AM modulation depth in percentage.

Syntax

GtWaveGetAmDepth (nHandle, nChannel, pdPercentDepth, 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.
pdPercentDepth
PDOUBLE
AM modulation depth in percentage 0% (no modulation) to 100% (full modulation).
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the AM modulation depth in percentage:

 

DOUBLE dPercentDepth;

GtWaveGetAmDepth (nHandle, GTWAVE_CHANNEL_A, &dPercentDepth, &nStatus);

 

See Also

GtWaveSetAmDepth, GtWaveSetAmFrequency, GtWaveSetAmSource, GtWaveSetAmState, GtWaveSetAmWaveform, GtWaveGetErrorString