Lock Workstation Action Icon

Log Off

 

Declaration

<AMLOGOFF FORCE="yes/no">

See Also

Lock Workstation | Log Off | Restart | Shut Down | Suspend/Hibernate | Empty Recycle Bin | End Process | Change Printer | Print | Set Date and Time | Run | Block Input | Generate Password

Description

Ends the Windows session for the current user, leaving the computer running in full power mode.

Practical Usage

Example 1: Administrators could create and deploy a task with this action to force the system to Log Off at a certain time at night.

Example 2: A task could be built very easily that would Log Off the system quickly with just the press of a hot-key combination.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

Force log off without notifying applications

Yes/No

No

No

FORCE="YES"

Specifies that the system should log off immediately without notifying and waiting for applications to return that they are ready to close.

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.

 

Description: Log off computer. Applications with unsaved changes will be forcibly closed.  

 

<AMLOGOFF FORCE="YES" />

 

↑ Top of Page