DioRealTimeCompareReadResults

Applies To

GX5290, GX5295, File

Purpose

Read a block of data from the onboard comparison result memory.

Syntax

DioRealTimeCompareReadResults (nHandle, pdwAddress, pdwData, pbComparedStatus, dwStart, pdwSize, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Board or File Board handle.
pdwAddress
PDWORD
Pointer to an array of type DWORD, array size has to at minimum equal to the number of steps to read.
pdwData
PDWORD
Pointer to an array of type DWORD, array size has to at minimum equal to the number of steps to read.
pbComparedStatus
PBOOL
Pointer to an array of type BOOL, array size has to at minimum equal to the number of steps to read. This array contains the comparison result for the specified Program counter and data. A value of TRUE
dwStart
DWORD
Result array index to start reading from.
dwSize
PDWORD
Number of items to read, the maximum number of comparison results is 1024. All of the three arrays need to be of the same size and at least equal to the pdwSize.  The returned data will be the lower of the two: if the specified pdwSize is less than the actual number of recorded comparisons or if the actual number of recorded comparisons is less than pdwSize.
Upon return pdwSize will be updated with the actual number of data points.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The board has to be in Real Time Compare operating mode prior calling this function. See the DioDomainSetupOperatingMode function for more details.

Note: the Real Time Compare functionality is supported by GX529x boards with firmware versions 0x8A00 and above.

The onboard comparison result memory is cleared each time the board is triggered.

Example

The following example reads 64 data points from the onboard comparison result memory beginning at 128:

 

DWORD dwAddress [64], dwData[64], dwSize=64;

BOOL bComparedStatus[64];

DioRealTimeCompareReadResults (nHandle, dwdAddress, dwData, bComparedStatus, 128, &dwSize, &nStatus);

 

See Also

DioRealTimeCompareSetupConditionValue, DioRealTimeCompareSetupDataDelay, DioRealTimeCompareSetupInputDataClockEdge, DioRealTimeCompareSetupResultsDataType, DioRealTimeCompareSetupStopCondition, DioRealTimeCompareWriteExpectedMemory, DioRealTimeCompareWriteMaskMemory, DioRealTimeCompareReadResults