CAPL Script

TestWaitForChange

This reference collection includes Vector documentation reproduced with permission. Snippets may require configuration-specific symbols and are not all standalone programs. Sources and validation limits.

Syntax

long TestWaitForChange(COValue value, dword timeoutMs)

Function

Waits for the next change of a communication object value. This is equivalent to callingTestWaitForChangeCountGreater (value, value.GetChangeCount(), timeoutMs). Note that only changes which occur while the function waits are considered. If you want to wait for changes which may occur earlier, or if you want to wait for several changes, useTestWaitForChangeFlagorTestWaitForChangeCountGreater.

Parameters

COValue Value of a communication object.

timeoutMS

Timeout in milliseconds.

Return Values

-2: Resume due to constraint violation

-1: General error, for example, functionality is not available

0: Resume due to timeout

1: resume due to event occurred (method was called)

Reference example from the CANoe 12 help. This is an incomplete context fragment: omitted surrounding code is shown as comments. Do not paste it as a complete program.

long ret;
consumedEventRef * anEvent;
anEvent = lookupConsumedEvent(path);
// // ... surrounding context omitted

ret = testWaitForChange(anEvent, 200);

TestWaitForChangeFlag | TestWaitForUpdate | TestWaitForUpdateCountGreater