GtWaveFuncGetPmState

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the Phase Modulation state.

Syntax

GtWaveFuncGetPmState (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.
1 = GTWAVE_CHANNEL_B: Channel B.
pdwStartAddress
PDWORD
GX1120: sync start address, any even value between 0 and 2097151.
GX1120: sync start address, any even value between 0 and 33554431.
pbState
PBOOL
Phase Modulation state:
0.      Disabled.
1.    Enabled
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the PM state:

 

BOOL   bState;

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

 

See Also

GtWaveFuncSetPmFrequency, GtWaveFuncSetPmSource , GtWaveFuncGetPmState, GtWaveFuncSetPmWaveform, GtWaveGetErrorString