WinUnlockSystem: Difference between revisions

← Older edit Newer edit →

Revision as of 09:12, 6 January 2017

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.

Returns

This function returns a BOOL with the values of:

TRUE
FALSE

Define (C/C++)

INCL_WINMESSAGEMGR

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 LockupHoo functions registered, they are called by the system during WinLockupSystem.

OS Version Introduced

OS/2 2.1

@@ Line 1: / Line 1: @@
-#REDIRECT [[OS2 API:PMI:WinUnlockSystem]]
+== WinUnlockSystem ==
+; WinUnlockSystem(anchorBlockHndl, password) : Allows an application to attempt to unlock the system.
+=== Parameters ===
+; anchorBlockHndl - [[OS2_API:DataType:HAB|HAB]] - input : The anchor block handle.
+; password - [[OS2_API:DataType:PSZ|PSZ]] - input : The password to unlock the system.
+=== Returns ===
+This function returns a [[OS2_API:DataType:BOOL|BOOL]] with the values of:
+* [[OS2_API:Constant:TRUE|TRUE]]
+* [[OS2_API:Constant:FALSE|FALSE]]
+=== Define (C/C++) ===
+INCL_WINMESSAGEMGR
+=== Calling conversion ===
+[[Cdecl32]]
+=== Example Code ===
+ [[OS2_API:DataType:HAB|HAB]]   hab;
+ [[OS2_API:DataType:PSZ|PSZ]]   password;
+ [[OS2_API:DataType:BOOL|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 ''LockupHoo'' functions registered, they are called by the system during [[WinLockupSystem]].
+=== OS Version Introduced ===
+OS/2 2.1
+[[Category:Win]]