WINDOWS Check if screen is unlocked function

The WINDOWS Check if screen is unlocked function in RPA.

Help CentreBuilding Processes

This article describes the RPA Windows functionality to check if the screen is unlocked.

For a full list of available functions, please read WINDOWS functions.


Description

The WINDOWS Check if screen is unlocked function checks whether the Windows session is currently unlocked and active, and stores the result as a boolean in a variable. This is the inverse of Check if screen is locked and is useful for confirming the desktop is ready for UI automation.


Setting it up

To use the WINDOWS Check if screen is unlocked function, follow these instructions:

{{popups:rpas/add:action=screen-unlocked}}

Once on a process map:

  1. Navigate to the process where you would like to add the WINDOWS Check if screen is unlocked function
  2. Click on the green button's drop-down (right side of the green button labelled "Process")
  3. On the menu that appears, click on the "+ Activity" item
  4. From here you can select the WINDOWS Check if screen is unlocked option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
VariableNoTextunlockedVariable name to store the result (true if unlocked, false if locked)

Output variables

VariableTypeDescription
unlockedBooleanTrue if the screen is currently unlocked, false if locked

Errors

This action does not produce specific errors.


Tips

  • Use this to confirm the desktop is ready before starting UI automation
  • Combine with a loop to wait until the screen is unlocked
  • Pair with Keep PC awake to prevent the screen from locking during automation

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.