Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

HtmlHelp (hhctrl)
 
.
Summary
Open HTML Help

C# Signature:

[DllImport("hhctrl.ocx", SetLastError=true)]
static extern IntPtr HtmlHelp( IntPtr hWndCaller, string helpFile, uint command, int data );

User-Defined Types:

    uint HH_DISPLAY_TOPIC = 0;
    uint HH_DISPLAY_TOC = 1;
    uint HH_DISPLAY_INDEX = 2;
    uint HH_DISPLAY_SEARCH = 3;
    uint HH_HELP_CONTEXT = 0x000F;
    uint HH_CLOSE_ALL = 0x0012;

VB Signature:

<DllImport("hhctrl.ocx", EntryPoint:="HtmlHelp", CharSet:=CharSet.Auto)> _
Function HTMLHelp( _
     ByVal hWndCaller As IntPtr, ByVal pszFile As String, _
     ByVal uCommand As Integer, ByVal dwData As Integer) As Integer
End Function

User-Defined Types:

Public Enum HTMLHelpCommand
     HH_DISPLAY_TOPIC = 0
     HH_DISPLAY_TOC = 1
     HH_DISPLAY_INDEX = 2
     HH_DISPLAY_SEARCH = 3
     HH_HELP_CONTEXT = &HF
     HH_CLOSE_ALL = &H12
End Enum

Notes:

None.

Tips & Tricks:

Article "How to use the unmanaged HTML Help API from a managed Visual C# application" on support.microsoft.com

Sample Code:

HTMLHelp(Nothing, filePath, HTMLHelpCommand.HH_HELP_CONTEXT, contextID)

or

HTMLHelp(Nothing, filePath, HTMLHelpCommand.HH_DISPLAY_TOC, 0)

Alternative Managed API:

System.Windows.Forms.Help.ShowHelp()

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Find References
Show Printable Version
Revisions