UserLock API documentation

Introduction

The UserLock API allows you to write your own .NET applications that will interact directly with the UserLock service. Basically the UserLock API allows you to programmatically create and configure protected accounts, deploy the agent, logoff/lock sessions, send popups to users.

Install the API

• Run the installation package with the /a switch.
• Select a folder to put all files.
• Get the files BaseLibrary.dll, NativeLibrary.dll and UserLockAPI.dll and store them in a folder.
• Add the file UserLockAPI.dll as reference in your Visual Studio .NET project (Visual Studio 2010 or higher because .NET 4.0 is required by UserLockAPI).

We advise you to keep these files in the folder of your executable in case UserLock gets upgraded. Thus, your executable will always have the correct version of these DLLs and you will not have to rebuild your application from source code when updating UserLock.

If the architecture used by your .NET application is 64-bit, make sure that you have installed the Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update (x64). If you need to install it, the download URL is https://www.microsoft.com/en-in/download/details.aspx?id=26999.

If the architecture used by your .NET application is 64-bit, you will need the 64-bit version of "NativeLibrary.dll". In this case, please contact us to obtain this file.

First steps

• Create an instance of the class UserLockServer. See examples in the constructor of the class.
• Call some methods on the instance of UserLockServer. See the following examples:

Examples

• Logoff all sessions of a specific user.
• Create, modify and update a protected account.
• Power off all workstations without any open session.
• Install the desktop agent on any workstation without it.
• Send a popup to all opened interactive sessions.