GtDio6xRealTimeCompareGetFailedVectors

Applies To

GX5296, GX5961, GX5964

Purpose

Returns a list of vectors that have a Real Time Compare error for the vectors contained within the specified step range.

Syntax

GtDio6xRealTimeCompareGetFailedVectors (nHandle, nVectorTestFlags, lStepStart, lStepCount, plFailedChannelCount, lChannelCount, palChannelList, plVectorAddressCount, lFailedVectorAddressesArraySize, palFailedVectorAddresses, 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.

 
nVectorTestFlags
SHORT
Used to specify the vector test flags:

0.    GTDIO6X_RTC_FAILED_CHANNELS_ALL: Channels with any failed vectors.

1.    GTDIO6X_RTC_FAILED_CHANNLES_WITH_C_FLAG: Channels only with failed C flag vectors (only GX5961 and  GX5964).

2.  GTDIO6X_RTC_FAILED_CHANNLES_WITH_E_FLAG: Channels only with failed E flag vectors (only GX5961 and  GX5964).

 
lStepStart
LONG
Start step.

 
lStepCount
LONG
Number of steps to process.

 
plFailedChannelCount
PLONG
Returns the number of unique channels found with failed vectors.
IChannelCount
LONG
Used to specify the number of channels in the palChanneList Array. If set to 0 then all Channels in the Domain are searched.
palChannelList
PLONG
An array to specify the channels to include in the search for vector errors. Only vectors with an error occuring in at least one of the channels specified in this array will be counted as an error in the palFailedVectorAddresses array.
palFailedChannels
LONG
An array to specify the failed channels.
plVectorAddressCount
PLONG
Returns the number of failed vectors found.

 
lFailedVectorAddressesArraySize
PLONG
Specifies the array size of the palFailedVectorAddresses array.

 
palFailedVectorAddresses
PLONG
Array with the failed vector addresses.

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

 

Comments

The function returns a list of vectors that have a Real Time Compare error for the vectors contained within the specified step range.

Example

The following example returns all the failed vectors  (within the channels 0 to 31 of the domain) with only with failed E flag vectors:

 

SHORT nHandle nStatus;

LONG alChannelListArray [32];

LONG lVectorAddressCount;

LONG alFailedVectorAddresses[4096];

//Fill alChannelListArray with the channels that will be included in the search for vector errors

for (i=0; i<32; i++)

    alChannelListArray[i]=i;

GtDio6xRealTimeCompareGetFailedVectors(nHandle, GTDIO6X_RTC_FAILED_CHANNLES_WITH_E_FLAG, 0, 0, 32, alChannelListArray , lVectorAddressCount alFailedVectorAddresses, &nStatus);

 

See Also

GtDio6xRealTimeCompareSetErrorAddressMemorySource, GtDio6xRealTimeCompareGetErrorCount, GtDio6xRealTimeCompareReadErrorAddressMemory, GtDio6xGetErrorString