GtWaveFuncGetPmDeviation

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the Phase Modulation deviation.

Syntax

GtWaveFuncGetPmDeviation (nHandle, nChannel, pdDeviation, 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.
pdDeviation
PDOUBLE
GX1120:
Phase Modulation deviation range is 0 to 360 degrees.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the Phase Modulation deviation:

 

DOUBLE dPhase;

GtWaveFuncGetPhase (nHandle, GTWAVE_CHANNEL_A, &dPhase, &nStatus);

 

See Also

GtWaveFuncSetPmDeviation, GtWaveFuncSetPmFrequency, GtWaveFuncSetPmSource, GtWaveFuncSetPmState, GtWaveFuncSetPmWaveform,GtWaveGetErrorString