WinLockupSystem: Difference between revisions
WinLockupSystem moved to OS2 API:WinLockupSystem |
mNo edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Puts the Workplace Shell into lock-down mode. | |||
==Syntax== | |||
WinLockupSystem(anchorBlockHandle) | |||
== Parameters == | |||
; anchorBlockHandle - [[HAB]] - input : Application's anchor block. | |||
== Returns == | |||
True if successful, false if not successful. | |||
*[[TRUE]] | |||
*[[FALSE]] | |||
== Define (C/C++) == | |||
INCL_WINMESSAGEMGR | |||
== Calling Convention == | |||
[[Cdecl32]] | |||
== Example Code == | |||
HAB anchorBlockHandle; | |||
BOOL rc; | |||
... | |||
rc = WinLockupSystem (anchorBlockHandle); | |||
== Related Functions == | |||
* [[WinUnlockSystem]] | |||
* WinSetHook | |||
== 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 and above | |||
[[Category:Win]] | |||
Latest revision as of 05:15, 20 May 2018
Puts the Workplace Shell into lock-down mode.
Syntax
WinLockupSystem(anchorBlockHandle)
Parameters
- anchorBlockHandle - HAB - input
- Application's anchor block.
Returns
True if successful, false if not successful.
Define (C/C++)
INCL_WINMESSAGEMGR
Calling Convention
Example Code
HAB anchorBlockHandle; BOOL rc; ... rc = WinLockupSystem (anchorBlockHandle);
Related Functions
- WinUnlockSystem
- WinSetHook
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 and above