Syntax

Notification.Wait( destinationPropObj, timeoutInSeconds, sequenceContextObj, processMsgs, waitRes)

Purpose

Waits until you Set or Pulse the notification. When the notification is already in a Set state, the Wait operation completes immediately.

Parameters

destinationPropObj As Object

[In] Specifies the PropertyObject in which to store the notification data. You can pass a NULL reference when you do not want to store the data. The type of the destination PropertyObject must be compatible with the data the notification sends. The Wait Behaviors for Data Set or Pulsed by Value and Wait Behaviors for Data Set or Pulsed by Reference tables illustrate the wait outcome depending on the type of the data and the data type of the storage location. In these tables, Simple Type refers to a number, string, Boolean, or array of any type, and Structured Type refers to an instance of a user-defined type where the root property is a container.

timeoutInSeconds As Double

[In] Specifies a timeout in seconds. Pass a negative number to specify that you do not want a timeout.

sequenceContextObj As Object

[In] Specifies a sequence context when you call this method from within a step of an execution. You must use the sequence context of the sequence in which you are calling this method. Pass a NULL reference when you do not call this method from an execution. This method uses the sequence context to improve the behavior of the execution when it is blocked while waiting on this method.

processMsgs As Boolean

[In] Pass True to process Microsoft Windows messages while waiting. When you call this method from an execution, pass True for this parameter. Otherwise, pass False .

waitRes As WaitResult

[Out] Returns the status of the operation.

See Also

Notification.PulseEx

Notification.SetEx

PropertyObject

Sequence Context

Wait Behaviors for Data Set or Pulsed by Reference

Wait Behaviors for Data Set or Pulsed by Value

WaitResult