WpSetLockupFullScreen

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

This instance method sets the value of the lockup full-screen option.

Syntax

wpSetLockupFullScreen(somSelf, bLockupFullScreen)

Parameters

somSelf (WPDesktop *) - input

Pointer to the object on which the method is being invoked.

Points to an object of class WPDesktop.

bLockupFullScreen (BOOL) - input

Value of the lockup full-screen option.

• TRUE Displays the full-screen lockup bitmap when locked.
• FALSE Displays the lockup window when locked.

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 full-screen 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 bLockupFullScreen; /* Value of the lockup full-screen option. */

wpSetLockupFullScreen(somSelf, bLockupFullScreen);

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

  Desktop = _wpclsQueryObjectFromPath("<WP_DESKTOP>");
  _wpSetLockupFullScreen(Desktop,TRUE);

Related Methods

• wpQueryLockupFullScreen