Main

Classes
class	Message
	Customizable message. More...
class	Permission
	Access control entry for UserLock administration permissions. More...
class	Permissions
	List of UserLock administration permissions. More...
class	ServerProperties
	UserLock server properties. More...
class	UserLockServer
	Instance of a local or remote UserLock server More...

Enumerations
enum	UserLockRights : uint {   ProtectedAccounts = 0x00000001, Messages = 0x00000002, UserSessions = 0x00000004, AgentDistribution = 0x00000008,   ServerProperties = 0x00000010, Permissions = 0x00000020, AllUserLockRightsRW = ProtectedAccounts | Messages | UserSessions | AgentDistribution | ServerProperties | Permissions, ProtectedAccountsRO = 0x00000040,   MessagesRO = 0x00000080, UserSessionsRO = 0x00000100, AgentDistributionRO = 0x00000200, ServerPropertiesRO = 0x00000400,   PermissionsRO = 0x00000800, AllUserLockRightsRO = ProtectedAccountsRO | MessagesRO | UserSessionsRO | AgentDistributionRO | ServerPropertiesRO | PermissionsRO, AllUserLockRights = AllUserLockRightsRO | AllUserLockRightsRW, All = 0xFFFFFFFF,   None = 0 }
	UserLock access rights. Bitmap. Used to know the access rights allowed for a connection to the UserLock server (UlConnection.Rights). Also used twice for each account listed in the UserLock administrative permissions: one for allowed permissions (Permission.AllowedRights) and one for denied permissions (Permission.DeniedRights). More...
enum	ServerMode { Backup, Primary, StandaloneTS, Invalid }
	Get the network zone protected by the UserLock service (Primary server mode). More...
enum	ServerPropertyList : int {   None = 0x0000, General = 0x0001, Logs = 0x0002, Security = 0x0004,   Synchronisation = 0x0008, TerminalServer = 0x0010, License = 0x0020, UserStatus = 0x0040,   AdminAccount = 0x0080, Advanced = 0x0100, Webhook = 0x0200, MFA = 0x0400,   AgentDistribution = 0x0800, All = General | Logs | Security | Synchronisation | TerminalServer | License | UserStatus | AdminAccount | Advanced | Webhook | MFA | AgentDistribution }
	Represent groups of server properties that will be synchronized between the server and a ServerProperties instance. Several values can be combined with the or (|) operator (flags). See the methods GetInfo and SetInfo of the ServerProperties class. More...
enum	ExceedingSessionsOrder { OldestFirst = 0, NewestFirst = 1 }
	Represent the chronological order for closing exceeding sessions. See the property ExceedingSessionsOrder of the ServerProperties class. More...
enum	ServerDataElement {   None = 0, AgentDistribution = 0x2, AgentDistributionProperties = 0x4, UserSessions = 0x40,   Messages = 0x80, Properties = 0x100, ProtectedAccounts = 0x200 }
	Allows to specify what for information needs to be refreshed from the server. See the Refresh method of the UserLockServer class. More...
enum	NotifyMode { Default = -1, ExecuteAfterTimeout = 0, PopupPeriod = 1 }
	Allows to specify the notify mode for a shutdown. See the Shutdown method of the UserLockServer class. More...
enum	ExecutionMode { Default = -1, Immediate = 0, ImmediateIfPossible = 1, AlwaysNotiFy = 2 }
	Allows to specify the execution mode for a shutdown. See the Shutdown method of the UserLockServer class. More...
enum	ForceMode { Default = -1, No = 0, Yes = 1 }
	Allows to specify if applications will be closed by force during a shutdown. See the Shutdown method of the UserLockServer class. More...

Detailed Description

Enumeration Type Documentation

enum UserLockRights : uint

UserLock access rights. Bitmap. Used to know the access rights allowed for a connection to the UserLock server (UlConnection.Rights). Also used twice for each account listed in the UserLock administrative permissions: one for allowed permissions (Permission.AllowedRights) and one for denied permissions (Permission.DeniedRights).

Enumerator
ProtectedAccounts	Protected accounts read-write access rights (0x1).
Messages	Customizable messages read-write access rights (0x2).
UserSessions	User sessions read-write access rights (Logoff, Lock, Send popup, Reset) (0x4).
AgentDistribution	Agent distribution read-write access rights (Install, Uninstall, Restart, Shut down, Wake up, Automatic mode, Agent configuration) (0x8).
ServerProperties	UserLock server properties read-write access rights (0x10).
Permissions	UserLock administrative permissions read-write access rights (0x20).
AllUserLockRightsRW	All read-write access rights (0x3F).
ProtectedAccountsRO	Protected accounts read-only access rights (0x40).
MessagesRO	Customizable messages read-only access rights (0x80).
UserSessionsRO	User sessions read-only access rights (0x100).
AgentDistributionRO	Agent distribution read-only access rights (0x200).
ServerPropertiesRO	UserLock server properties read-only access rights (0x400).
PermissionsRO	UserLock administrative permissions read-only access rights (0x800).
AllUserLockRightsRO	All read-only access rights (0xFC0).
AllUserLockRights	All read-write and read-only access rights (0xFFF).
All	All access rights (0xFFFFFFFF).
None	No access rights (0x0).

enum ServerMode

Get the network zone protected by the UserLock service (Primary server mode).

Enumerator
Backup	This is a backup server
Primary	This is a primary server
StandaloneTS	The UserLock service only protects terminal sessions to the local server.
Invalid	Invalid server mode.

enum ServerPropertyList : int

Represent groups of server properties that will be synchronized between the server and a ServerProperties instance. Several values can be combined with the or (|) operator (flags). See the methods GetInfo and SetInfo of the ServerProperties class.

Enumerator
None	No properties will be get/set
General	General properties will be get/set
Logs	Logs properties will be get/set
Security	Security properties will be get/set
Synchronisation	Synchronization properties will be get/set
TerminalServer	Standalone terminal server properties will be get/set
License	License properties will be get/set
UserStatus	User Status properties will be get/set
AdminAccount	The admin account to access protected computers will be get/set
Advanced	The advanced properties will be get/set
Webhook	The webhook properties will be get/set
MFA	The MFA properties will be get/set
AgentDistribution	The AgentDistribution properties will be set
All	All properties will be get/set

enum ExceedingSessionsOrder

Represent the chronological order for closing exceeding sessions. See the property ExceedingSessionsOrder of the ServerProperties class.

Enumerator
OldestFirst	UserLock will first consider older sessions as exceeding sessions and close them.
NewestFirst	UserLock will first consider newer sessions as exceeding sessions and close them.

enum ServerDataElement

Allows to specify what for information needs to be refreshed from the server. See the Refresh method of the UserLockServer class.

Enumerator
None	No information will be refreshed.
AgentDistribution	The agent distribution status will be refreshed.
AgentDistributionProperties	The agent distribution properties will be refreshed.
UserSessions	Sessions will be refreshed.
Messages	Messages will be refreshed.
Properties	Server properties will be refreshed.
ProtectedAccounts	Protected accounts will be refreshed.

enum NotifyMode

Allows to specify the notify mode for a shutdown. See the Shutdown method of the UserLockServer class.

Enumerator
Default
ExecuteAfterTimeout	Execute after displaying the notification during a specified time interval.
PopupPeriod	Popup the notification again after a specified time interval. The action will be execute only when the user decide.

enum ExecutionMode

Allows to specify the execution mode for a shutdown. See the Shutdown method of the UserLockServer class.

Enumerator
Default	Default execution mode configured in agent distribution properties.
Immediate	Immediate execution.
ImmediateIfPossible	Immediate execution if this is a workstation and no user has an open session. Otherwise a notification is displayed.
AlwaysNotiFy	A notification is always displayed before executing the system action.

enum ForceMode

Allows to specify if applications will be closed by force during a shutdown. See the Shutdown method of the UserLockServer class.

Enumerator
Default	Default force mode configured in agent distribution properties.
No	Don't force applications to close.
Yes	Force applications to close.