CAPL Script

TestWaitForUpdate

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)

long ret;consumedEventRef * anEvent;anEvent = lookupConsumedEvent(path);// ...ret = testWaitForUpdate(anEvent, 200);

[TestWaitForUpdateFlag](/en/syntax/communication-objects/misc/testwaitforupdateflag) | [TestWaitForChange](/en/syntax/communication-objects/misc/testwaitforchange) | [TestWaitForChangeCountGreater](/en/syntax/communication-objects/misc/testwaitforchangecountgreater)