NewOutputMessage Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.NewOutputMessage ( messageText, categoryText = "", severity = OutputMessageSeverity_Information, sequenceContext = NULL)

Return Value

OutputMessage

Purpose

Creates and returns a new OutputMessage object.

Remarks

When creating a new object, TestStand initializes the OutputMessage.TimeStamp property to the current time, sets the OutputMessage.TextColor property to black, and sets the OutputMessage.IconName property based on the severity.

You must call the OutputMessage.Post method to copy the message to the collection the Engine.GetOutputMessages method returns.

Parameters

messageText As String

[In] Specifies the message text.

categoryText As String

[In] Specifies 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] Specifies the sequence context of the current execution, if available. TestStand extracts information from the sequence context to construct the OutputMessage.FileLocations and OutputMessage.ExecutionLocations properties for the new object.

This parameter has a default value of NULL.


See Also

Engine.GetOutputMessages

Engine.NewOutputMessages

Output Messages (Example)

OutputMessage

OutputMessage.ExecutionLocations

OutputMessage.FileLocations

OutputMessage.IconName

OutputMessage.Post

OutputMessage.TextColor

OutputMessage.TimeStamp

OutputMessageSeverityTypes

SequenceContext

WAS THIS ARTICLE HELPFUL?

Not Helpful