View source for WpDisplayHelp

{{DISPLAYTITLE:wpDisplayHelp}}
This instance method is called to allow the object to display a help panel.

==Syntax==
 _wpDisplayHelp(somSelf, HelpPanelId, HelpLibrary)

==Parameters==
;''somSelf'' ([[WPObject]] *) - input
:Pointer to the object on which the method is being invoked.
:Points to an object of class WPObject.

;''HelpPanelId'' ([[ULONG]]) - input
:Object's help panel ID.

;''HelpLibrary'' ([[PSZ]]) - input
:A pointer to a zero-terminated string which contains the name of the help library.

==Returns==
;''rc'' ([[BOOL]]) - returns
:Success indicator.
::TRUE: Successful completion.
::FALSE: Error occurred.

==Remarks==
This method allows each object class to display a help panel in response to a user's request for help. The help panel will be displayed by the shell on a help instance managed by the shell.

==Usage==
This method can be called at any time in order to display a help panel.

==How to Override==
This method is generally not overridden.

==Example Code==
This example overrides wpMenuItemHelpSelected and provides help for the Hex and Text view popup menu selections.
<PRE>
SOM_Scope BOOL   SOMLINK Browse_O_Maticwps_wpMenuItemHelpSelected(Browse_O_Matic *somSelf,
                                 ULONG MenuId)
{
    /* Browse_O_MaticData *somThis = Browse_O_MaticGetData(somSelf); */
    Browse_O_MaticMethodDebug("Browse_O_Matic","Browse_O_Maticwps_wpMenuItemHelpSelected");

    switch( MenuId){

      case ID_OPEN_TEXT:
         return( _wpDisplayHelp( somSelf, PANEL_HELP_OPEN_TEXT, "pmbrowse.hlp"));

      case ID_OPEN_HEX:
         return( _wpDisplayHelp( somSelf, PANEL_HELP_OPEN_HEX, "pmbrowse.hlp"));

      default:
         break;
    }

    return( FALSE);
}
</PRE>

==Related Methods==
* [[wpMenuItemHelpSelected]]
* [[wpQueryDefaultHelp]]
* [[wpSetDefaultHelp]]
* [[wpclsQueryDefaultHelp]]

[[Category:Workplace Instance Methods]]