GtWaveArbGetSync

Supported By

GX1110, GX1120

Applies To

Arbitrary Waveform Generator mode only.

Purpose

Returns the waveform sync bit state to the specified waveform memory locations.

Syntax

GtWaveArbGetSync (nHandle, nChannel, pdwStartAddress, pdwLength, pbState, 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.
pdwStartAddress
PDWORD
GX1120: sync start address, any even value between 0 and 2097151.
GX1120: sync start address, any even value between 0 and 33554431.
pdwLength
PDWORD
GX1120: sync length can be any value between 1 and 2097152.
If pdwLength is -1 will automatically fill all the steps between the start address and the end of the memory.
GX1120: When waveform length is set to be less than 2048, the sync can only start on multiples of 2 points and have length of multiples of 2. Otherwise, sync can only start on multiples of 8 points and have length of multiples of 8 and be between 1 and 33554432.
pbState
PBOOL
GX1120: Sync to be set to On or Off to the specified waveform memory locations.
GX1120: not applicable.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the sync output address and length (pulse width) of the signal available at the Sync Out connector.

Example

The following example returns the waveform sync:

 

DWORD  dwStartAddress, dwLength=-1;

BOOL   bState;

GtWaveArbSetSync (nHandle, GTWAVE_CHANNEL_A, &dwStartAddress, &dwLength, &bState, &nStatus);

 

See Also

GtWaveArbSetSync , GtWaveArbSetSampleRate, GtWaveArbSetWaveformLength, GtWaveArbFillPredefinedWaveform,  GtWaveArbReadWaveformData, GtWaveArbWriteWaveformData, GtWaveArbFileLoad, GtWaveArbFileSave