TSTool / Command / Message

• Overview
• Command Editor
• Command Syntax
• Examples
• Troubleshooting
• See Also

---

Overview

The Message command prints a status message to the log file (status level 2). Optionally, the CommandStatus parameter can be used to control the status level for the command, for example to generate a warning or failure status for the command. This command is useful for troubleshooting processing. See also the If command, which can be used to check for a condition and by using Message print a message to warn the user.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

Message Command Editor Showing Conditions Test (see also the full-size image)

Command Syntax

The command syntax is as follows:

Message(Parameter="Value",...)

Command Parameters

Parameter	Description	Default
Message required	The message to print. Can be specified using ${Property}.	None - must be specified.
CommandStatus	Indicate the status that should result from running the command: SUCCESS, WARNING, FAILURE	SUCCESS

Examples

See the automated tests.

Troubleshooting

See Also

• StartLog command - controls log file where messages are written