Syntax

OutputMessage(String message, String category = "", Number severity = 0, [Number textColor], [String icon])

Return Value

This function always returns 0.

Parameters

message as String

A string containing the message to be displayed in the output window.

category as String

(Optional) Specifies the category of the message. If you do not specify a category, the output message will be considered uncategorized. You can define your own categories. The default value is an empty string.

severity as Number

(Optional) Specifies the severity of the message. The valid values are:      0 - (Default) OutputMessageSeverity_Information.      1 - OutputMessageSeverity_Warning.      2 - OutputMessageSeverity_Error.

textColor as Number

(Optional) Specifies the text color used to display the message. Use a color constant such as tsBlack, or use the RGB function to specify a color using component color values.

icon as String

(Optional) Specifies the name of the icon file related to the output message. The TestStand Engine obtains the icons from the <TestStand>\ComponentsIcons and <TestStand Public>\ComponentsIcons directories. This parameter is optional and the default icon is selected based on the severity of the message.