Jump to content

WinLockupSystem: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
mNo edit summary
 
Line 4: Line 4:
  WinLockupSystem(anchorBlockHandle)
  WinLockupSystem(anchorBlockHandle)


=== Parameters ===
== Parameters ==
; anchorBlockHandle - [[HAB]] - input : Application's anchor block.
; anchorBlockHandle - [[HAB]] - input : Application's anchor block.


=== Returns ===
== Returns ==
True if successful, false if not successful.
True if successful, false if not successful.
*[[TRUE]]
*[[TRUE]]
*[[FALSE]]
*[[FALSE]]


=== Define (C/C++) ===
== Define (C/C++) ==
INCL_WINMESSAGEMGR
INCL_WINMESSAGEMGR


=== Calling Convention ===
== Calling Convention ==
[[Cdecl32]]
[[Cdecl32]]


=== Example Code ===
== Example Code ==
  HAB  anchorBlockHandle;
  HAB  anchorBlockHandle;
  BOOL rc;
  BOOL rc;
Line 24: Line 24:
  rc = WinLockupSystem (anchorBlockHandle);
  rc = WinLockupSystem (anchorBlockHandle);


=== Related Functions ===
== Related Functions ==
* [[WinUnlockSystem]]
* [[WinUnlockSystem]]
* WinSetHook
* WinSetHook


=== Notes ===
== 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.
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.


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


=== OS Version Introduced ===
== OS Version Introduced ==
OS/2 2.1 and above
OS/2 2.1 and above


[[Category:Win]]
[[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

Cdecl32

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