GtWaveFuncGetPwmWidth

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the pulse-width modulation width.

Syntax

GtWaveFuncGetPwmWidth (nHandle, nChannel, pdWidth, 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.  
pdWidth  
PDOUBLE  
Pulse-width range is 0% to 100%
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the PWM width:

 

DOUBLE dWidth;

GtWaveFuncGetPwmWidth (nHandle, GTWAVE_CHANNEL_A, &dWidth, &nStatus);

 

See Also

GtWaveFuncSetPwmWidth, GtWaveFuncGetPwmWaveform, GtWaveFuncSetPwmFrequency, GtWaveFuncSetPwmSource, GtWaveFuncGetPwmState, GtWaveGetErrorString