NewOutputMessage Method
Syntax
Engine.NewOutputMessage ( messageText, categoryText = "", severity = OutputMessageSeverity_Information, sequenceContext = NULL)
Return Value
Purpose
Creates and returns a new OutputMessage object.
Remarks
When creating a new object, TestStand initializes the OutputMessage.TimeStamp property to the current time, the OutputMessage.TextColor property to black, and the OutputMessage.IconName property based on the severity.
You must call OutputMessage.Post to copy the message to the collection returned by the GetOutputMessages method.
Release the reference to this object when you finish using it.
Parameters
messageText As String
[In] Pass the message text.
categoryText As String
[In] Pass the category of the message. Applications typically use the category to filter or sort messages. If you do not specify a category, the output message is considered uncategorized. You can specify any value for this parameter.
This parameter has a default value of "".
severity As OutputMessageSeverityTypes
[In/Out] Specifies the severity of the output message.
This parameter has a default value of OutputMessageSeverity_Information.
sequenceContext As SequenceContext
[In] Pass the sequence context of the current execution, if available. TestStand extracts information from the sequence context to contruct the OutputMessage.FileLocations and OutputMessage.ExecutionLocations properties for the new object.
This parameter has a default value of NULL.