GtDio6xRealTimeCompareGetErrorAddressMemorySource

Applies

GX5296, GX5961, GX5964, File

Purpose

Returns the source of the Real Time Compare Error Address Memory.

Syntax

GtDio6xRealTimeCompareGetErrorAddressMemorySource (nHandle, pnErrorAddressMemorySource, 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.
pnErrorAddressMemorySource
PSHORT
Returns the Error Address Memory source.

0.  GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_BOARD: Only locally (within a board) generated errors will be recorded.

1.  GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_DOMAIN: Any error generated from any board in the domain will be recorded.

2.  GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_BOARDGTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_BOARD_VECTOR_E_FLAG: Only locally generated errors from vectors with the E Flag set will be recorded (only GX5961 and  GX5964).

3.    GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_DOMAINGTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_DOMAIN_VECTOR_E_FLAG: Any error generated from any board in the domain form vectors with the E Flag set will be recorded (only GX5961 and  GX5964).

pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The Error Address Memory records up to 1024 real time compare errors. The source of the Error Address Memory can be selected using this function. Board wide or Domain wide errors can be recorded. Furthermore, vectors can be marked with the E Test flag in order to qualify them for inclusion in the Error Address Memory. Use the GtDio6xWriteVectorTestFlagsMemory API to set the vector Test flags.

If the Error Address Memory Source is set to GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_BOARD or GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_DOMAIN then only qualified Vectors will be allowed to generate errors that will be recorded. (Errors generated from Vectors without the E flag will be disregarded in this case).

Example

The following example sets the real time compare error address memory source to Only locally generated errors from vectors with the E Flag set will be recorded, and returns the error address memory source:

 

SHORT nHandle, nErrorAddressMemorySource;

SHORT nStatus;

 

GtDio6xRealTimeCompareSetErrorAddressMemorySource(nHandle, GTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_BOARDGTDIO6X_RTC_ADDRESS_MEMORY_SOURCE_BOARD_VECTOR_E_FLAG, &nStatus);

 

GtDio6xRealTimeCompareGetErrorAddressMemorySource(nHandle, &nErrorAddressSource, &nStatus);

 

See Also

GtDio6xRealTimeCompareSetErrorAddressMemorySource, GtDio6xWriteVectorTestFlagsMemory, GtDio6xRealTimeCompareSetJumpSource, GtDio6xRealTimeCompareSetErrorAddressMemorySource, GtDio6xReadVectorMemory, GtDio6xWriteVectorMemory, GtDio6xFillVectors, GtDio6xGetErrorString