Skip to main content

​
TestWaitForChange

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

​
Function Syntax

long TestWaitForChange(valueHandle * value, dword timeoutMs);

​
Description

Waits for the next change of a valueHandle. This is equivalent to calling TestWaitForChangeCountGreater (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, use TestWaitForChangeFlag or TestWaitForChangeCountGreater. In case of a distributed object, this functionality is only available if the [EnableChangeInfo] attribute is enabled for the respective object.

​
Parameters

  • value: Value handle of a communication object or distributed object.
  • timeoutMS: Maximum time that should be waited [ms]. Transmission of 0: no timeout controlling.

​
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)

​
Example

long ret;
consumedEventRef * anEvent;
anEvent = lookupConsumedEvent(path);
// ...
ret = testWaitForChange(anEvent, 200);
Programming with the Communication Concept (C#, Python and CAPL) • TestWaitForChangeFlag • TestWaitForUpdate • TestWaitForUpdateCountGreater