Jump to content

wpQueryLockupFullScreen

From EDM2

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 full-screen option.

Syntax

_wpQueryLockupFullScreen(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
Lockup full-screen option.
  • TRUE Displays the full-screen lockup bitmap when locked.
  • FALSE Displays the lockup window when locked.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to determine 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 rc; /* Lockup full-screen option. */

rc = _wpQueryLockupFullScreen(somSelf);

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

  Desktop = _wpclsQueryObjectFromPath("<WP_DESKTOP>");
  bFullScreen = _wpQueryLockupFullScreen(Desktop);

Related Methods