Jump to content

wpQueryLockupTimeout

From EDM2

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

This instance method returns the current timeout value for automatic lockup.

Syntax

_wpQueryLockupTimeout(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 (ULONG) - returns
Timeout value in minutes.

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 timeout value 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. */
ULONG rc; /* Timeout value in minutes. */

rc = _wpQueryLockupTimeout(somSelf);

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

  Desktop = _wpclsQueryObjectFromPath("<WP_DESKTOP>");
  ulTimeout = _wpQueryLockupTimeout(Desktop);

Related Methods