Syntax

Notification.Pulse( dataPropObj, byRef, applyToAllWaiters)

Purpose

Remarks

Notifies one or all currently waiting threads. This method differs from the Notification.Set method because this method notifies only those threads already waiting when the Pulse operation occurs. Threads that wait on the notification after a Pulse operation occurs block until you send the Set or Pulse notification again. A Pulse operation places the notification in a Cleared state, even when the notification was in a Set state before the Pulse operation.

Parameters

dataPropObj As Object

[In] Specifies an optional PropertyObject data element to store with the Set state of the notification. Threads that wait on the notification can then optionally retrieve this data. You can use data of any type, including a number, string, Boolean, object reference, structured type (container), or arrays of these types. When you later wait on the notification, you must store the element in a PropertyObject with the appropriate type. You can pass NULL for this parameter.

byRef As Boolean

[In] When you pass False , the notification stores a copy of the data you specify in the dataPropObj parameter. When you pass True , the notification stores an object reference to the data value.

applyToAllWaiters As Boolean

[In] Pass True to notify all currently waiting threads. Pass False to notify just the first waiting thread.

See Also

Notification.Clear

Notification.PulseEx

Notification.Set

Notification.Wait

PropertyObject