HH_SAFE_DISPLAY_TOPIC command

HTML Help API

HH_SAFE_DISPLAY_TOPIC command

Opens a help topic in a specified help window, and disables all shortcuts in the current process. Shortcuts will remain disabled as long as the calling process is active. This command can be used in place of HH_DISPLAY_TOPIC.

If a window type is not specified, a default window type is used. If the window type or default window type is open, the help topic replaces the current topic in the window.

pszFile dwData
Specifies a compiled help (.chm) file, or a specific topic within a compiled help file.

To specify a defined window type, insert a greater-than (>) character followed by the name of the window type.

Specifies NULL or a pointer to a topic within a compiled help file.

Example


HWND hwnd =

HtmlHelp(
GetDesktopWindow(),
"file:///c:\\help.chm::/intro.htm>mainwin",
HH_SAFE_DISPLAY_TOPIC,
NULL) ;

Return value

The handle (hwnd) of the help window.

Comments

A default help window contains only the Topic pane and is not a three-pane Help Viewer.

The HH_SAFE_DISPLAY_TOPIC command will only work with the following standard protocols:

  • ftp:
  • http:
  • https:
  • ms-its:
  • its:
  • file:
  • mk@msitstore:

See also

HH_HELP_CONTEXT

HH_DISPLAY_TOPIC


link to overview topic About commands