GtWaveFuncGetSweep
Supported
By
GX1120
Applies To
Function Generator mode only.
Purpose
Returns the sweep parameters.
Syntax
GtWaveFuncGetSweep
(nHandle, nChannel, pdStartFreq,
pdStopFreq , pdTime , pnMode , 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. |
pdStartFreq
|
PDOUBLE
|
Sweep
stop frequency range is 1 uHz to 100MHz |
pdStopFreq
|
PDOUBLE
|
Sweep
stop frequency range is 1 uHz to 100MHz |
pdTime
|
PDOUBLE
|
Sweep
time range is from 1mSec to 500Sec |
pnMode
|
PSHORT
|
Sweep
Mode:
0. GTWAVE_GX1120_SWEEP_MODE_LINEAR:
linear sweep
GTWAVE_GX1120_SWEEP_MODE_LOGARITHMIC:
logarithmic sweep
v |
pnStatus |
PSHORT |
Returned status: 0 on success, negative
number on failure. |
Example
The following example returns the sweep parameters:
DOUBLE dStartFreq,
dStopFreq, dTime;
SHORT nMode;
GtWaveFuncGetSweep
(nHandle, GTWAVE_CHANNEL_A, 100, 100000, 0.1, GTWAVE_GX1120_SWEEP_MODE_LINEAR,
&nStatus);
See Also
GtWaveFuncGetSweepState,
GtWaveFuncGetSweep, GtWaveFuncSetSweep,
GtWaveFuncSetWaveform, GtWaveFuncSetSquareWaveDutyCycle, GtWaveFuncSetFrequency, GtWaveFuncSetOutToSquareState,
GtWaveFuncSetPhase, GtWaveGetErrorString