Notification.SetEx
- Updated2024-10-09
- 1 minute(s) read
Notification.SetEx
Syntax
Notification.SetEx( sequenceContextObj, dataPropObj, byRef, autoClear)
Purpose
Notifies one or more threads that an event has occurred or a condition has been met. When the notification is in a Set state, Wait operations on the notification succeed immediately.
Parameters
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.
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. Subsequent wait operations 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.
autoClear As Boolean
[In] Specifies to clear the state of the notification after one thread receives the notification. Once you clear the state of a notification, subsequent Wait operations block until you perform another Set operation.