Set Operation

Use the Set operation to notify 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. Enable the Set option on the left of the Notification Settings panel.

The Set operation contains the following options:

• Notification Name or Reference Expression —The notification on which to perform the operation. You can specify the notification by name or by the object reference you receive when you create the notification using the Use Object Reference for the Notification Reference Lifetime option.
• Data Value (optional) —An optional data element to store with the set state of the notification. Threads that wait on the notification can then optionally retrieve this data. The data can be 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 into a location with the appropriate type. By default, the notification stores a copy of the value. However, when you enable the Store Data by Reference Instead of by Value option, the operation stores an ActiveX reference to the value instead. If you later store this reference into an object reference variable in the Wait operation, you can access the data using the TestStand API PropertyObject interface and the ActiveX/COM Adapter.
• Store Data by Reference Instead of by Value —Specifies how to store the data you specify in the Data Value control. Enable the option when you want to store an ActiveX reference to the property. Disable the option when you want to store a copy of the data.
• Auto Clear After Notifying One Thread —When you enable this option, TestStand clears 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.