LogTrace()

Writes a user-defined trace message in the Log Viewer.

Category

Miscellaneous

Syntax

LogTrace( msg );

Parameter

msg

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

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.

LogTrace() is similar to LogMessage(), but displays the message as Trace when Log Trace is enabled.

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

Example

LogTrace("User-defined trace message.");

This statement writes to the Log Viewer as follows:

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

<ObjectName.ScriptName>: User-defined trace message.

Related Topics

Miscellaneous Functions