Jump to content

wpclsQueryIcon

From EDM2
Revision as of 21:33, 25 May 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpclsQueryIcon}} This class method is called to allow the class object to specify the default icon to be used for its instances. ==Syntax== _wpclsQueryIcon(somSelf) ==Parameters== ;'''somSelf''' (M_WPObject *) - input :Pointer to the WPObject class object. ;'''hptrSuccess''' (HPOINTER) - returns :Success indicator. NULL Error occurred. Other Handle to an icon. ==Returns== ;'''hptrSuccess''' (HPOINTER) - returns :Success indicator. NULL Erro...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This class method is called to allow the class object to specify the default icon to be used for its instances.

Syntax

_wpclsQueryIcon(somSelf)

Parameters

somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hptrSuccess (HPOINTER) - returns
Success indicator. NULL Error occurred. Other Handle to an icon.

Returns

hptrSuccess (HPOINTER) - returns
Success indicator. NULL Error occurred. Other Handle to an icon.

Remarks

The class default icon can be loaded on wpclsInitData and freed on wpclsUnInitData.

How to Override

This method is overridden in order to change the default icon for an instance of the class.

Usage

This method can be called at any time in order to determine the default icon for instances of this class.

Example Code

Declaration:

#define INCL_WINWORKPLACE
#include <os2.h>

M_WPObject     *somSelf;      /*  Pointer to the WPObject class object. */
HPOINTER        hptrSuccess;  /*  Success indicator. */

hptrSuccess = _wpclsQueryIcon(somSelf);

This example returns the handle to an icon.

SOM_Scope HPOINTER   SOMLINK pviewM_wpclsQueryIcon(M_PictureViewer *somSelf)
{
    /* M_PictureViewerData *somThis = M_PictureViewerGetData(somSelf); */
    M_PictureViewerMethodDebug('M_PictureViewer','pviewM_wpclsQueryIcon');

/*    return (parent_wpclsQueryIcon(somSelf));   don't call parent method */
      return ( _hIcon );                         /* Return own Icon */
}

Related Methods