TestWaitForUpdateFlag
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 TestWaitForUpdateFlag(COValue value, dword timeoutMs)
Function
Waits for the update flag of a communication object value to be set. Each CO value has an update flag which is set when the value is updated and reset through an explicit call tovalueEntity::ClearUpdateFlagorvalueEntity::ResetValueState. Use this function instead ofTestWaitForUpdateif an undetermined number of updates may occur between a point where you reset the flag and a point where at least one update must have occurred.
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 (update flag was set)
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);
anEvent.ClearUpdateFlag();
// // ... surrounding context omitted
ret = testWaitForUpdateFlag(anEvent, 200);
Related APIs
TestWaitForUpdate | TestWaitForChange | TestWaitForChangeFlag