LogMessage()

Writes a user-defined message to the Log Viewer.

Category

Miscellaneous

Syntax

LogMessage( msg );

Parameter

msg

The message to write to the Log Viewer. Actual string or a string attribute.

Remarks

This is a very powerful function for troubleshooting scripting. By strategically placing LogMessage() functions in your scripts, you can determine the order of script execution, performance of scripts, and identify the value of attributes both before they are changed and after they are affected by the script.

Each message posted to the Log Viewer is stamped with the exact date and time. The message always begins with the component "Tagname.ScriptName" so you can tell what object and what script within the object posted the message to the log.

Examples

LogMessage("Report Script is Running");

The above statement writes the following to the Log Viewer:

10/24/2005 12:49:14 PM ScriptRuntime <Tagname.ScriptName>:Report Script is Running.

MyTag=MyTag + 10;

LogMessage("The Value of MyTag is " + Text(MyTag, "#"));