WinUnlockSystem: Difference between revisions
m Redirected page to OS2 API:PMI:WinUnlockSystem |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Allows an application to attempt to unlock the system. | |||
WinUnlockSystem(anchorBlockHndl, password) | |||
=== 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 Convention === | |||
[[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 | |||
[[Category:Win]] | |||
Latest revision as of 19:35, 14 May 2025
Allows an application to attempt to unlock the system.
WinUnlockSystem(anchorBlockHndl, password)
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:
Define (C/C++)
INCL_WINMESSAGEMGR
Calling Convention
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