Computer - Lock

Declaration

<AMCOMPUTER ACTIVITY="lock" />

Related Topics   

Description

Submits a request to lock the workstation's display.

Practical Usage

Commonly used as the final step in a task to lock the workstation in order to protect it from unauthorized use. It is common to use this activity to lock the workstation if the task was started when it was locked.

Parameters

No parameters.

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample task checks the AMTrigger.Locked dataset to determine if the workstation was initially locked when the task started. If it was in a locked state, the task re-locks the workstation before completion.

Copy
<AMVARIABLE NAME="AMTrigger.WasLocked" ISPARAMETER="YES" VALUE="1"></AMVARIABLE>
<!-- Place these steps at the end of the task to make it re-lock if the task was started locked -->
<AMIF EXPRESSION="%AMTrigger.WasLocked% = 1"><AMLOCKWORKSTATION /></AMIF>
<AMCOMPUTER ACTIVITY="lock" />
<AMIF ACTIVITY="end" />