Log Event Icon

Log Event

Declaration

<LOGEVENT MESSAGE="text (message to log)" TYPE="text (options)" />

See Also

Change Printer | Display | Empty Recycle Bin | End Process | Get Process Information | Get Volume Information | Log Event | Print | Registry | Set Date and Time

Description

Logs an event to the Windows Event Log (not supported on Windows 95/98/ME).

Practical Usage

Can be used to write an event to the Windows Event Log in order to launch another task set with an Event Log trigger monitoring the specified Event.

Parameters

General Properties

Property

Type

Req'd

Default

Markup

Description

Message

Text

Yes

(Empty)

MESSAGE="Task C failed"

The text message that should be logged.

Message Type

Text (options)

No

Information

TYPE="warning"

How the message should be classified in the Windows Event Log. The available options are:

  • Information: The event will be classified as an informational message.

  • Warning: The event will be classified as a warning.

  • Error: The event will be classified as an error.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

 

<LOGEVENT MESSAGE="Be advised - Task C failed." TYPE="error" />

 

↑ Top of Page