HH_HELP_CONTEXT
Displays a help topic based on a context ID.
Argument | Description |
---|---|
hwndCaller | Handle of parent window or 0 |
pszFile | HTML Help URL: Compiled help (.chm) file [>Window] |
uCommand | HH_HELP_CONTEX |
dwData | Numeric ID of the topic to display (context ID) |
Return value:
On success the result is the handle to the helpwindow that was opened. On failure the
return value is 0. You can use the HH_GET_LAST_ERROR
command to get more detailed information.
Description:
The HH_HELP_CONTEXT command allows you to display a help topic from a specific helpfile
using a numeric ID (context ID). This requires that you map these numeric IDs to a topic.
This is done by using the Map and Alias tabs in the HTML Help API Information dialog in
HTML Help Workshop.
Example:
The code snippet attempts to display a topic from the JediHtmlHelp.chm helpfile by using
the numeric identifier 1000. The JediHtmlHelp.chm helpfile has the following IDs mapped:
ID | Topic |
---|---|
1000 | Api Reference\Commands\Commands.htm |
1001 | Api Reference\Structures\Structures.htm |
1002 | Api Reference\Notifications\Notification Messages.htm |
HtmlHelp(0, PChar('JediHtmlHelp.chm'), HH_HELP_CONTEXT, 1000);
See also:
HH_DISPLAY_TOPIC
HH_DISPLAY_TEXT_POPUP