GtWaveGetAmFrequency

Supported By

GX1110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Returns the AM modulation frequency.

Syntax

GtWaveGetAmFrequency (nHandle, nChannel, pdFrequency, 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.
pdFrequency
PDOUBLE
GX1120:
AM modulation frequency range is from 0.01Hz to 20KHz
GX1120:
AM modulation frequency range is from 0.01Hz to 20KHz
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the AM modulation frequency:

 

DOUBLE dFrequency;

GtWaveGetAmFrequency (nHandle, GTWAVE_CHANNEL_A, &dFrequency, &nStatus);

 

See Also

GtWaveSetAmDepth, GtWaveSetAmFrequency, GtWaveSetAmSource, GtWaveSetAmState, GtWaveSetAmWaveform, GtWaveGetErrorString