Notification Step Configuration Dialog Box

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Wait Operation

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

The Wait 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. You can use the Wait operation to specify multiple notifications using either a string array containing the names of the notifications or an object reference array containing ActiveX references to the notifications. When you specify multiple notifications, the Wait operation waits until you Set or Pulse any of the notifications in the array. If you Set or Pulse more than one of the notifications, the Wait operation responds to the notification that appears first in the array. To ascertain which notification the Wait operation responds to, use the Which Notification control to specify a location to store the array offset of the notification.
  • Location to Store Data (optional output)—A location to store the notification data. Leave this control blank when you do not want to store the data. The type of the location must be compatible with the data the notification sends. The following 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.

    Wait Behaviors for Data Set or Pulsed by Value

    Storage Type—Destination Set or Pulse Data Type (By Value)—Source
    Simple Type Structured Type Object Reference
    Simple Type If the types match, Wait copies the data to the location you specify. If the types do not match, Wait reports a type mismatch error. Type mismatch error. Type mismatch error.
    Structured Type Type mismatch error. Replaces the property you specify as the storage location with a copy of the structured value the notification stores. Type mismatch error.
    Object Reference Type mismatch error. Stores an ActiveX reference to the structured value the notification stores. Copies the ActiveX reference the notification stores to the location you specify.

    Wait Behaviors for Data Set or Pulsed by Reference

    Storage Type—Destination Set or Pulse Data Type (By Reference)—Source
    Simple Type Structured Type Object Reference
    Simple Type If the types match, Wait copies the data to the location you specify. If the types do not match, Wait reports a type mismatch error. Type mismatch error. Type mismatch error.
    Structured Type Type mismatch error. Makes a copy of the structured value the notification stores by reference and replaces the property you specify as the storage location with the copy. Type mismatch error.
    Object Reference Stores an ActiveX reference to the simple type the notification stores. Stores an ActiveX reference to the structured value the notification stores. Stores an ActiveX reference to the ActiveX reference the notification stores.
  • Which Notification? (optional output)—The location for storing the array offset of the notification to which the operation responds. Typically, you do not use this control unless you wait on multiple notifications. Use the Notification Name or Reference Expression control for this operation to specify a wait for multiple notifications.
  • Timeout Enabled, Timeout Expression, Timeout Causes Run-Time Error—A timeout behavior when waiting for a notification. If a timeout occurs, the Step.Result.TimeoutOccurred property is set to True.

WAS THIS ARTICLE HELPFUL?

Not Helpful