GtWaveFuncGetPmWaveform

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the Phase Modulation waveform.

Syntax

GtWaveFuncSetPmWaveform (nHandle, nChannel, pnWaveform, 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.
pnWaveform
PSHORT
Standard waveform can be one of the following:
0.      GTWAVE_WAVEFORM_SINE: Sinusoidal waveform.
1.      GTWAVE_WAVEFORM_SQUARE: Square waveform.
2.      GTWAVE_WAVEFORM_TRIANGLE: Triangular waveform.
3.      GTWAVE_WAVEFORM_RAMP_UP: Positive ramp waveform
GTWAVE_WAVEFORM_RAMP_DOWN: Negative ramp waveform
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the PM modulation waveform:

 

SHORT  nWaveform;

GtWaveFuncGetPmWaveform (nHandle, GTWAVE_CHANNEL_A, &nWaveform, &nStatus);

 

See Also

GtWaveFuncSetPmWaveform, GtWaveFuncSetPmFrequency, GtWaveFuncSetPmSource , GtWaveFuncGetPmState, GtWaveGetErrorString