GtWaveArbGetMarker

Supported By

GX1110, GX1120

Applies To

Arbitrary Waveform Generator mode only.

Purpose

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

Syntax

GtWaveArbGetMarker (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.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
1 = GTWAVE_CHANNEL_B: Channel B.
pdwStartAddress
PDWORD
GX1120: Waveform start address, any even value between 0 and 2097151.
GX1120: Waveform start address, any even value between 0 and 33554431.
pdwLength
PDWORD
GX1120: Waveform 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 marker can only start on multiples of 2 points and have length of multiples of 2. Otherwise, marker can only start on multiples of 8 points and have length of multiples of 8 and be between 1 and 33554432.
pbState

 
PBOOL
GX1120: Marker to be set to On or Off for specified waveform memory locations.
GX1120: not applicable.
dParam1
DOUBLE
If standard waveform is square, this parameter specifies the duty cycle in percents.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

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

Example

The following example returns the waveform marker:

 

DWORD  dwStartAddress, dwLength=-1;

BOOL   bState;

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

 

See Also

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