GtWaveFuncSetFmFrequency

Supported By

GX1110, GX1120

Applies To

Function Generator mode only.

Purpose

Sets the FM frequency.

Syntax

GtWaveFuncSetFmFrequency (nHandle, nChannel, dFrequency, 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.
dFrequency
DOUBLE
GX1120:
Frequency range is 0.01Hz to 20KHz
GX1120:
Frequency range is 0.01Hz to 20KHz
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example sets the FM modulation frequency to 10KHz:

 

GtWaveFuncSetFmFrequency (nHandle, GTWAVE_CHANNEL_A, 10e3, &nStatus);

 

See Also

GtWaveFuncGetFmFrequency, GtWaveFuncSetFmSource, GtWaveFuncSetFmState, GtWaveFuncSetFmWaveform, GtWaveGetErrorString