GtWaveFuncGetPwmState

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the pulse-width modulation state.

Syntax

GtWaveFuncGetPwmState (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.
pbState  
PBOOL  
Pulse-width modulation state:
0.      Disabled.
1.    Enabled.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the PWM state:

 

BOOL   bState;

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

 

See Also

GtWaveFuncSetPwmFrequency, GtWaveFuncSetPwmSource, GtWaveFuncSetPwmState, GtWaveFuncSetPwmWaveform, GtWaveGetErrorString