OS2 API:WinUnlockSystem

Contents 1 WinUnlockSystem 1.1 Parameters 1.2 Constants 1.3 Returns 1.4 Module 1.5 Define (C/C++) 1.6 Export name/Ordinal 1.7 Calling conversion 1.8 Example Code 1.9 Related Functions 1.10 Notes 1.11 OS Version Introduced

WinUnlockSystem

WinUnlockSystem(anchorBlockHndl, password) 

Allows an application to attempt to unlock the system.

Parameters

anchorBlockHndl - HAB - input 

The anchor block handle.

password - PSZ - input 

The password to unlock the system.

Constants

Returns

This function returns a BOOL with the values of:

• TRUE
• FALSE

Module

Define (C/C++)

INCL_WINMESSAGEMGR

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

...
HAB   hab;
PSZ   password;
BOOL rc;
...
rc = WinUnlockSystem (hab, password);
...

Related Functions

LookupHook WinLockupSystem

Notes

To unlock the Workplace Shell a call must be made to WinUnlockSystem through a different thread. This is due to WinLockupSystem not returning from its call until the call to WinUnlockSystem is successful.

A program will display a password entry dialog to be completed. The program will make a call to WinUnlockSystem with the HAB and password. The dialog displaying the lockup message should have the WS_CLIPSIBLINGS style.

If there are any LockupHook functions registered, they are called by the system during WinLockupSystem.

OS Version Introduced

OS/2 2.1

Back to OS/2 API