Engine.GetOutputMessages
- Updated2024-10-09
- 1 minute(s) read
Engine.GetOutputMessages
Syntax
Engine.GetOutputMessages
Return Value
Purpose
Returns a reference to the OutputMessages object TestStand maintains. This object is a collection that contains a list of the most recent output messages the OutputMessage.Post method or OutputMessage expression function posts.
Remarks
In TestStand 4.0 and 4.0.1, an application could access this collection in response to the UIMsg_OutputMessages event to obtain new output messages. The application was expected to clear the collection in the handler for this event. If the application did not handle the event or did not clear the collection, the collection could grow without bounds. In TestStand 4.1 or later this method is deprecated, and this collection clears automatically if the application fails to clear it in response to the UIMsg_OutputMessages event. In addition, TestStand adds a warning output message to the collection to notify users about automatically discarded output messages and that the application incorrectly accessed GetOutputMessages without clearing the collection. Although existing applications can handle the UIMsg_OutputMessages event by calling GetOutputMessages and clearing the collection, ensure that new application code obtains the OutputMessages collection that contains the most recent output messages from the ActiveXData member of the user interface message for the UIMsg_OutputMessages event.