Log

Syntax

Command Description Return Value
Log <string> Writes a message to the system log The message is returned
Log Clear Clears the important message indicator The number of messages cleared
Log Reset Removes all messages from the system log The number of messages removed
Log ? Returns the current important message count The number of important messages pending

Abbreviation

None

Description

The Log command writes a message to the system log.

Using Log Clear will acknowledge new important messages by clearing the message indicator.

Using Log Reset will remove all messages from the system log.

Using Log ? will return the number of new messages in the system log.

Examples

Log "This is a test"
Writes the string “This is a test” to the system log.

Log "Current cue is ${myCue}"
Writes the string “Current cue is “, followed by the value of the myCue variable to the system log. (See the section on Strings for more information about substituting variable values into strings.)

Log Clear
Clears the “important message” indicator.

Log ?
Returns the number of important messages in the system log.