GtWaveFuncGetFmState

Supported By

GX1110, GX1120

Applies To

Function Generator mode only.

Purpose

Returns the FM state.

Syntax

GtWaveFuncGetFmState (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
FM state:
0=Disabled.
1=Enabled.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Note: External AM needs to be disabled before calling this function.

Example

The following example returns the FM state:

 

BOOL   bState;

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

 

See Also

GtWaveFuncSetFmFrequency, GtWaveFuncSetFmSource, GtWaveFuncSetFmState, GtWaveFuncSetFmWaveform, GtWaveGetErrorString