LogWarning()

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

Category

Miscellaneous

Syntax

LogWarning( msg );

Parameter

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.

LogWarning() is similar to LogMessage(), but displays the message as a yellow warning message.

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

Example

LogWarning("User-defined warning message.")

This statement writes to the Log Viewer as follows:

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

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