GtWaveFuncGetPhase

Supported By

GX1110, GX1120

Applies To

Function Generator mode only.

Purpose

Returns the function generator’s output starting phase in units of degrees.

Syntax

GtWaveFuncGetPhase (nHandle, nChannel, pdPhase, 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.
pdPhase
PDOUBLE
Output start phase in units of degrees, -360 to 360.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The parameter defines the starting phase angle for the sine waveform.

Example

The following example returns the function generator’s phase:

 

DOUBLE dPhase;

GtWaveFuncGetPhase (nHandle, GTWAVE_CHANNEL_A, &dPhase, &nStatus);

 

See Also

GtWaveFuncSetWaveform, GtWaveFuncSetSquareWaveDutyCycle, GtWaveFuncSetFrequency, GtWaveFuncSetPhase, GtWaveGetErrorString