HH_ALINK_LOOKUP command

HTML Help API

HH_ALINK_LOOKUP command

Looks up one or more Associative link (ALink) names in a compiled help (.chm) file.

The ALink names 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 ALink names. 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_ALINK_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 ALink names into target topic files using the HTML Help Compiler Information feature.
  • An ALink name lookup can also be invoked using the HTML Help ActiveX control ALink command.
  • ALink name/KLink keyword lookups are case sensitive. Multiple keywords are delimited by a semicolon.

See also

HH_KEYWORD_LOOKUP


link to overview topic About commands