Jump to content

wpAddSystemPrintScreenPage

From EDM2
Revision as of 22:38, 10 September 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpAddSystemPrintScreenPage}} This instance method is called to allow the object to add the '''Print Screen''' page to its Settings notebook. ==Syntax== _wpAddSystemPrintScreenPage(somSelf, hwndNotebook); ==Parameters== ;''somSelf'' (WPSystem *) - input :Pointer to the object on which the method is being invoked. :Points to an object of class WPSystem. ;''hwndNotebook'' (HWND) - input :Settings notebook handle. ==Returns== ;''rc'' ([[ULONG]...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This instance method is called to allow the object to add the Print Screen page to its Settings notebook.

Syntax

_wpAddSystemPrintScreenPage(somSelf, hwndNotebook);

Parameters

somSelf (WPSystem *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPSystem.
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 should always be overridden in order to replace or remove the Print Screen page 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

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

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

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

    return ( SETTINGS_PAGE_REMOVED );
}

Related Methods