GtWaveFuncGetPwmDeviation

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the pulse-width modulation deviation.

Syntax

GtWaveFuncGetPwmDeviation (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
DOUBLE
GX1120:
Pulse-width modulation deviation (gain) is 0% to 100%
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the pulse-width modulation deviation:

 

DOUBLE dDeviation;

GtWaveFuncGetPwmDeviation (nHandle, GTWAVE_CHANNEL_A, &dDeviation, &nStatus);

 

See Also

GtWaveFuncSetPwmDeviation, GtWaveFuncSetPwmFrequency, GtWaveFuncSetPwmSource, GtWaveFuncSetPwmState, GtWaveFuncSetPwmWaveform,  GtWaveGetErrorString