LogError()

Writes a user-defined error message in the Log Viewer with a red error log flag.

Category

Miscellaneous

Syntax

LogError( msg );

Parameter

msg

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

Remarks

The log flag is enabled 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.

LogError() is similar to LogMessage(), but displays the message in red.

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

Example

LogError("User-defined error message.");

This statement writes to the Log Viewer as follows:

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

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

Related Topics

Miscellaneous Functions