GxAoArbReadWaveform

Purpose

Returns the specified waveform to an array.

Applies

GX1649, GX1649-1, GX1632e

Syntax

GxAoArbReadWaveform (nHandle, nGroup, nChannel, pvWaveform, pdwWaveformSize, nWaveformType, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to GX1649 or GX1632e board.
nGroup
SHORT
Group number:
0.   GXAO_GROUPA
1.   GXAO_GROUPB
2.   GXAO_GROUPC
3.   GXAO_GROUPD
nChannel
PSHORT
Channel number (0-15).  Not applicable to GX1632e.
pvWaveform
PVOID
Buffer to hold the returned waveform array of Words or Doubles (see nWaveformType).
pdwWaveformSize
PDWORD
Returns TRUE if ARB Group is in streaming mode and FALSE if ARB group is in non-streaming mode.
nWaveformType
SHORT
The type of waveform data to write:
0.   GXAO_WAVEFORM_TYPE_WORD
1.   GXAO_WAVEFORM_TYPE_DOUBLE
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The internal RAM of the GX1632e is not accessible.  If this function targets a GX1632e, it will read the values which were last written using GxAoArbWriteWaveform.

This function was previously called GxAoArbReadChannelWaveform

Example

The following example returns the clock source and frequency for group A:

 

SHORT  nStatus;

DOUBLE adWave[]={1.0, 2.0, 3.0, 4.0};

DWORD  dwSize=4;

 

GxAoArbWriteWaveform(nHandle, GXAO_GROUPA, 0, adWave, dwSize, GXAO_WAVEFORM_TYPE_DOUBLE, &nStatus);

GxAoArbReadWaveform(nHandle, GXAO_GROUPA, 0, adWave, &dwSize, GXAO_WAVEFORM_TYPE_DOUBLE, &nStatus);

 

See Also

GxAoArbSetGroupChannels, GxAoArbWriteWaveform, GxAoGetErrorString