HH_KEYWORD_LOOKUP command

HTML Help API

HH_KEYWORD_LOOKUP command

Looks up one or more keywords in a compiled help (.chm) file.

The keywords to search for and the action to be taken if no matches are found are specified in the HH_AKLINK structure.

pszFile dwData

Specifies the compiled help (.chm) file that contains keywords.

Points to an HH_AKLINK structure.


Example


HH_AKLINK link;

link.cbStruct = sizeof(HH_AKLINK) ;
link.fReserved = FALSE ;
link.pszKeywords = "open" ;
link.pszUrl = NULL ;
link.pszMsgText = NULL ;
link.pszMsgTitle = NULL ;
link.pszWindow = NULL ;
link.fIndexOnFail = TRUE ;

HtmlHelp(
GetDesktopWindow(),
"c:\\myhelp.chm",
HH_KEYWORD_LOOKUP,
(DWORD)&link;);

Return Value

The handle (hwnd) of the help window.

Comments

  • You must first call the HH_DISPLAY_TOPIC command before calling this command to ensure that the help window is created.
  • Help authors insert keywords into topic files using the HTML Help Compiler Information feature.
  • A keyword lookup can also be invoked using the HTML Help ActiveX control KLink command.
  • ALink Name/Keyword lookups are case sensitive, and multiple keywords are delimited by a semicolon (;).

See Also

HH_ALINK_LOOKUP


link to overview topic About commands