Jump to content

wpAddSetPathPage

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 Set-Path page to the Settings notebook.

Syntax

_wpAddSetPathPage(somSelf, hwndNotebook);

Parameters

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

Returns

rc (ULONG) - returns
Page identifier.
A return value of 0 indicates that an 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 can be overridden to replace or remove the Set-Path page from the object's Settings notebook.

Example Code

This example overrides the method to eliminate this page from the object's Settings notebook.

SOM_Scope ULONG SOMLINK MyObj_wpAddSetPathPage(MyObj somSelf,
                HWND hwndNotebook)
{
    / MyObjData *somThis = MyObjGetData(somSelf); */
    MyObjMethodDebug("MyObj","MyObj_wpAddSetPathPage");

/*  return (parent_wpAddSetPathPage(somSelf,hwndNotebook)); */

    return ( SETTINGS_PAGE_REMOVED );
}

Related Methods