GtWaveFuncGetPwmFrequency

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the pulse-width modulation frequency.

Syntax

GtWaveFuncGetPwmFrequency(nHandle, nChannel, pdFrequency, 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.
pdFrequency
PDOUBLE
GX1120:
Frequency range is 0.01Hz to 20KHz
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the pulse-width modulation frequency:

 

DOUBLE dFrequency;

GtWaveFuncGetPwmFrequency (nHandle, GTWAVE_CHANNEL_A, &dFrequency, &nStatus);

 

See Also

GtWaveFuncSetPwmFrequency, GtWaveFuncSetPwmSource, GtWaveFuncSetPwmState, GtWaveFuncSetPwmWaveform, GtWaveGetErrorString