GtWaveFuncGetOutToSquareDutyCycle

Supported By

GX1110, GX1120

Applies To

Function Generator mode only.

Purpose

Returns the output to square state.

Syntax

GtWaveFuncGetOutToSquareState (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.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
1 = GTWAVE_CHANNEL_B: Channel B.
pbState  
PBOOL
Returns the output to square state:
0=FALSE: Out to square state not active.
1=TRUE: Out to square state active.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the output to square state:

 

BOOL   bState;

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

 

See Also

GtWaveFuncSetOutToSquareDutyCycle, GtWaveFuncSetWaveform, GtWaveFuncSetSquareWaveDutyCycle GtWaveFuncSetFrequency, GtWaveFuncSetOutToSquareState, GtWaveFuncSetPhase, GtWaveGetErrorString