OS2 API:WinLockupSystem

Contents 1 WinLockupSystem 1.1 Parameters 1.2 Constants 1.3 Returns 1.4 Module 1.5 Define (C/C++) 1.6 Export name/Ordinal 1.7 Calling conversion 1.8 Example Code 1.9 Related Functions 1.10 Notes 1.11 OS Version Introduced

WinLockupSystem

WinLockupSystem(anchorBlockHandle) 

Puts the Workplace Shell into lock-down mode.

Parameters

anchorBlockHandle - HAB - input 

Application's anchor block.

Constants

Returns

True if successful, false if not successful.

• TRUE
• FALSE

Module

Define (C/C++)

INCL_WINMESSAGEMGR

Export name/Ordinal

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, eCS 1.0 and above

Back to OS/2 API