Jump to content

wpAddObjectGeneralPage2

From EDM2

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

This instance method is called to allow the object to add the **Animation Icon** page to its Settings notebook.

Syntax

_wpAddObjectGeneralPage2(somSelf, hwndNotebook)

Parameters

somSelf (WPObject *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPObject.
hwndNotebook (HWND) - input
Settings notebook handle.

Returns

rc (ULONG) - returns
Page identifier.
0: Error occurred.
PageId: Identifier for the inserted page.

Usage

This method must be called only from within an override of the wpAddSettingsPages method.

How to Override

This method should always be overridden in order to replace or remove the General page 2 from the object's Settings notebook. To remove the page from the Settings notebook, the override method should return SETTINGS_PAGE_REMOVED without calling the parent method. To replace the page with another page, the override method should call the wpInsertSettingsPage method without calling the parent method.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPObject      *somSelf;       /* Pointer to the object on which the method is being invoked. */
HWND           hwndNotebook;  /* Settings notebook handle. */
ULONG          rc;            /* Page identifier. */

rc = _wpAddObjectGeneralPage2(somSelf, hwndNotebook);

Related Methods