WpSetLockupAutoDim: Difference between revisions

Latest revision as of 03:32, 25 November 2025

This method is specific to Version 4, or higher, of the OS/2 operating system.

This instance method sets the value of the lockup auto-dim option.

Syntax

wpSetLockupAutoDim(somSelf, bLockupAutoDim)

Parameters

somSelf (WPDesktop *) - input: Pointer to the object on which the method is being invoked.; Points to an object of class WPDesktop.

bLockupAutoDim (BOOL) - input

The value of the lockup auto-dim options.

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.

Returns

rc (none) - returns: There is no return value for this method.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to set the lockup automatic dim option for the current desktop.

Remarks

This method is not covered in the provided text.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPDesktop *somSelf; /* Pointer to the object on which the method is being invoked. */
BOOL bLockupAutoDim; /* The value of the lockup auto-dim options. */

wpSetLockupAutoDim(somSelf, bLockupAutoDim);

/* Example code provided in the source: */
  WPDesktop *Desktop;

  Desktop = _wpclsQueryObjectFromPath("<WP_DESKTOP>");
  _wpSetLockupAutoDim(Desktop,FALSE);

Related Methods