GtWaveFuncGetFrequency

Supported By

GX1110, GX1120

Applies To

Function Generator mode only.

Purpose

Returns the function generator modulation frequency.

Syntax

GtWaveFuncGetFrequency (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.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
1 = GTWAVE_CHANNEL_B: Channel B.
pdFrequency
PDOUBLE
GX1120:
Function generator frequency, frequency range is (GTWAVE_GX1120_FUNC_MIN_FREQUENCY) 10uHz to (GTWAVE_GX1120_FUNC_MAX_FREQUENCY) 30MHz
GX1120:
Function generator frequency, frequency range is (GTWAVE_GX1120_FUNC_MIN_FREQUENCY) 10uHz to (GTWAVE_GX1120_FUNC_MAX_FREQUENCY) 100MHz
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the function generator's modulation frequency:

 

DOUBLE dFrequency;

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

 

See Also

GtWaveFuncSetWaveform, GtWaveFuncSetSquareWaveDutyCycle, GtWaveFuncSetFrequency, GtWaveFuncSetOutToSquareState, GtWaveFuncSetPhase, GtWaveGetErrorString