WinLockupSystem: Difference between revisions
Appearance
m Redirected page to OS2 API:PMI:WinLockupSystem |
No edit summary |
||
Line 1: | Line 1: | ||
== WinLockupSystem == | |||
; WinLockupSystem(anchorBlockHandle) : Puts the Workplace Shell into lock-down mode. | |||
=== Parameters === | |||
; anchorBlockHandle - [[HAB]] - input : Application's anchor block. | |||
=== Returns === | |||
True if successful, false if not successful. | |||
*[[TRUE]] | |||
*[[FALSE]] | |||
=== Define (C/C++) === | |||
INCL_WINMESSAGEMGR | |||
=== Calling conversion === | |||
[[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]] |
Revision as of 09:17, 6 January 2017
WinLockupSystem
- WinLockupSystem(anchorBlockHandle)
- Puts the Workplace Shell into lock-down mode.
Parameters
- anchorBlockHandle - HAB - input
- Application's anchor block.
Returns
True if successful, false if not successful.
Define (C/C++)
INCL_WINMESSAGEMGR
Calling conversion
Example Code
HAB anchorBlockHandle; BOOL rc; ... rc = WinLockupSystem (anchorBlockHandle);
Related Functions
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