IDocHostShowUI::ShowHelp Method

---

Called by MSHTML when it needs to display Help.

Syntax

HRESULT STDMETHODCALLTYPE ShowHelp( 
    HWND hwnd,
    LPOLESTR pszHelpFile,
    UINT uCommand,
    DWORD dwData,
    POINT ptMouse,
    IDispatch *pDispatchObjectHit
);

Parameters

hwnd

Handle to the owner window.

pszHelpFile

Address of string containing a Help file name.

uCommand

Unsigned integer which represents the type of Help. See the WinHelp function.

dwData

DWORD which contains additional data. See the WinHelp function.

ptMouse

POINT structure containing the mouse position in screen coordinates.

pDispatchObjectHit

Address of the IDispatch of the object at the screen coordinates.

Return Value

Returns one of the following values:
 

S_OK	Host displayed Help. MSHTML will not display its Help.
S_FALSE	Host did not display Help. MSHTML will display its Help.

Remarks

The first four parameters are the same as those passed to the WinHelp function. The ptMouse parameter gives the screen coordinates, and the pDispatchObjectHit parameter allows the host to differentiate the object at the screen coordinates to a greater degree than MSHTML.