GtWaveResetChannel

Supported By

GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Sets the board to its default settings

Syntax

GtWaveResetChannel (nHandle, nChannel, 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.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Calling this function does not change the operation mode, but resets the specified channel to its default state.

The function calls GtWaveSynchronizePhases API before returning.

Example

The following example resets the board:

 

GtWaveResetChannel (nHandle, GTWAVE_CHANNEL_A, &nStatus);

 

See Also

GtWaveInitialize, GtWaveReset, GtWaveGetErrorString