TestWaitForUpdate
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 TestWaitForUpdate(COValue value, dword timeoutMs)
Function
Waits for the next update of a communication object value. This is equivalent to callingTestWaitForUpdateCountGreater (value, value.GetUpdateCount(), timeoutMs). Note that only updates which occur while the function waits are considered. If you want to wait for updates which may occur earlier, or if you want to wait for several updates, useTestWaitForUpdateFlagorTestWaitForUpdateCountGreater.
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 (value was updated)
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 = testWaitForUpdate(anEvent, 200);
Related APIs
TestWaitForUpdateFlag | TestWaitForChange | TestWaitForChangeCountGreater