system.security.isScreenLocked

This function is used in Python Scripting.

Description

Returns whether or not the screen is currently locked.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.security.isScreenLocked()

Parameters

Nothing

Returns

Boolean - A flag indicating whether or not the screen is currently locked.

Scope

Vision Client

Code Example

Code Snippet

# This would run in a timer script to lock the screen after 15 seconds of inactivity, and then log the user out after 30 seconds of inactivity.
  
if system.util.getInactivitySeconds() > 15 and not system.security.isScreenLocked():
   system.security.lockScreen()
elif system.util.getInactivitySeconds() > 30:
   system.security.logout()

Keywords system security isScreenLocked, security.isScreenLocked