GtWaveFuncGetFmSource

Supported By

GX1110, GX1120

Applies To

Function Generator mode only.

Purpose

Returns the FM modulation source.

Syntax

GtWaveFuncGetFmSource (nHandle, nChannel, pnSource, 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.
pnSource
PSHORT
FM modulation source can be:
GTWAVE_FUNC_FM_SOURCE_INTERNAL: FM source is an internal waveform.
GTWAVE_FUNC_FM_SOURCE_EXTERNAL: FM source is external.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the FM source:

 

SHORT nSource;

GtWaveFuncGetFmSource (nHandle, GTWAVE_CHANNEL_A, &nSource, &nStatus);

 

See Also

GtWaveFuncSetFmFrequency, GtWaveFuncSetFmSource, GtWaveFuncSetFmState, GtWaveFuncSetFmWaveform, GtWaveGetErrorString