GtDio6xRealTimeCompareReadAllErrorData

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns all Real time Compare data associated with failed vectors for the specified board.

Syntax

GtDio6xRealTimeCompareReadAllErrorData (nHandle, dwErrorStart, dwErrorCount, padwErrorStepArray, padwErrorVectorArray, padwRecordFailedChannelsArray, dwVectorMemoryArraySize, pucVectorMemoryArray, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Session identifier:

●     Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.

●     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.
dwErrorStart
DWORD
Used to specify the beginning error number of the error address memory to query. The valid range is 0 to 1023.
dwErrorCount
DWORD
Used to specify the number of errors to query.
The Number or Errors plus the Starting Error must be less than or equal to 1024.
padwErrorStepArray
PDWORD
Used to return an array containing the Steps that generated real time compare errors.
The array must have at least as many elements as is specified in the dwErrorCount parameter.
padwErrorVectorArray
PDWORD
Used to return an array contain the Vectors that generated errors.
The array must have at least as many elements as is specified in the dwErrorCount parameter.
padwRecordFailedChannelsArray
PDWORD
Used to return an array contain the record memory with the generated errors.
The array must have at least as many elements as is specified in the dwErrorCount parameter.
dwVectorMemoryArraySize
DWORD
Used to specify the number of vectors to read. The size needs to be in multiplications of 32 channels in order to read back all the channels’ vector data for the specified vector number.
pucVectorMemoryArray
PCHAR
Used to return an array of Vector data. The array passed must contain at least as many elements as specified by dwVectorMemoryArraySize.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The error address memory records the Step, and Vector address of the first 1024 errors that have occurred during a sequencer Run.

Step:  This indicates the Step that was running when the error occurred.

Vector:  This indicates the Vector that the error occurred on.

The type of errors that are recorded can be set by calling GtDio6xRealTimeCompareSetErrorAddressMemorySource.

Example

The following reads the first 20 entries from the Error Address Memory:

 

DWORD adwStepErrorArray[20];

DWORD adwVectorErrorArray[20];

DWORD adwRecordFailedChannelsArray[20];

CHAR aucVectorMemoryArray[640];

SHORT nStatus;

 

GtDio6xRealTimeCompareReadAllErrorData(nHandle, dwErrorStart, dwErrorCount, adwErrorStepArray, adwErrorVectorArray, adwRecordFailedChannelsArray, 32*20, aucVectorMemoryArray, &nStatus);

See Also

GtDio6xRealTimeCompareReadErrorAddressMemory, GtDio6xSequencerReset, GtDio6xGetErrorString