LogCustom()

Writes a user-defined custom flag message in the Log Viewer.

Category

Miscellaneous

Syntax

LogCustom( CustomFlag, msg );

Parameter

CustomFlag

Creates a new log flag based on the first parameter string. The first call creates the custom flag.

msg

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

Remarks

The log flag is disabled by default.

The message is always logged under the component "ObjectName.ScriptName". For example, "WinPlatform_001.script1: msg", which identifies what object and what script within the object logged the error.

LogCustom() is similar to LogMessage(), but displays the message in the custom log flag when Log Custom is enabled.

The parameter help tooltip and Function Browser sample parameter list will show "LogCustom( CustomFlag, msg )" rather than "LogCustom( CustomFlag, Message )". "Message" is a reserved keyword.

Example

LogCustom(EditBox1.text, "User-defined message.";

This statement writes to the Log Viewer as follows:

10/24/2005 12:49:14 PM ScriptRuntime

<ObjectName.ScriptName>: <LogFlag EditBox1> User-defined message.