wpQueryLockupAutoDim
This method is specific to Version 4, or higher, of the OS/2 operating system.
This instance method returns the current value of the lockup auto-dim option.
Syntax
_wpQueryLockupAutoDim(somSelf)
Parameters
- somSelf (WPDesktop *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPDesktop.
Returns
- rc (BOOL) - returns
- Current value of the lockup auto-dim option.
- TRUE Clears the screen and displays the floating lock after the timeout.
- FALSE Does not clear the screen or display the floating lock after the timeout.
How to Override
This method is generally not overridden.
Usage
This method can be called at any time in order to determine the lockup automatic dim option for the current desktop.
Example Code
#define INCL_WINWORKPLACE
#include <os2.h>
WPDesktop *somSelf; /* Pointer to the object on which the method is being invoked. */
BOOL rc; /* Current value of the lockup auto-dim option. */
rc = _wpQueryLockupAutoDim(somSelf);
/* Example code provided in the source: */
WPDesktop *Desktop;
BOOL bAutoDim;
Desktop = _wpclsQueryObjectFromPath("<WP_DESKTOP>");
bAutoDim = _wpQueryLockupAutoDim(Desktop);