GtDio6xRealTimeCompareSetJumpSource

Applies To

GX5961, GX5964, File

Purpose

Sets the Real Time compare jump source.

Syntax

GtDio6xRealTimeCompareSetJumpSource (nHandle, nControlErrorSource, bPassValidEnable, 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.

 
nControlErrorSource
SHORT
Set the error signal used to determine the jump PASS/FAIL state:

0.    GTDIO6X_RTC_JUMP_ERROR_SOURCE_BOARD: Board’s Real Time Compare failure will cause a jump.

1.   GTDIO6X_RTC_JUMP_ERROR_SOURCE_DOMAIN: Domain’s Real Time Compare failure will cause a jump.

2.  GTDIO6X_RTC_JUMP_ERROR_SOURCE_BOARD_VECTOR_C_FLAG: Board’s Real Time Compare failure from vectors with the C (condition) Flag enabled will cause a jump.

3.   GTDIO6X_RTC_JUMP_ERROR_SOURCE_DOMAIN_VECTOR_C_FLAG: Domain’s Real Time Compare failure from vectors with the C (condition) Flag enabled will cause a jump.

bPassValidEnable
BOOL
Set the Pass Valid Enable:

0.    FALSE: Do not use pass valid signal.

1.    TRUE: define the PASS as a VALID PASS, where no channel errors were detected but there must be at least one valid pattern expect code.

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

Comments

Select if the Control Logic will use All Local Errors, All Domain Errors, Local Qualified.

Errors, or Domain Qualified Errors (see GtDio6xWriteVectorTestFlagsMemory) to act (to determine the jump PASS/FAIL state).

Example

The following example sets real time compare jump source to Domain’s Real Time Compare failure will cause a jump and return the settings:

 

SHORT nStatus;

SHORT nControlErrorSource;

BOOL bPassValidEnable;

GtDio6xRealTimeCompareSetJumpSource (nHandle, GTDIO6X_RTC_JUMP_ERROR_SOURCE_DOMAIN, FALSE, &nStatus);

GtDio6xRealTimeCompareGetJumpSource (nHandle, &nControlErrorSource, &bPassValidEnable, &nStatus);

 

See Also

GtDio6xRealTimeCompareGetJumpSource, GtDio6xStepSetControl, GtDio6xStepGetControl, GtDio6xGetErrorString