THHAKLink
Specifies the parameters for keyword searches.
Used by:
HH_KEYWORD_LOOKUP
HH_ALINK_LOOKUP
Declaration:
PHHAKLink = ^THHAKLink;
tagHH_AKLINK = packed record
cbStruct: Integer;
fReserved: BOOL;
pszKeywords: LPCTSTR;
pszUrl: LPCTSTR;
pszMsgText: LPCTSTR;
pszMsgTitle: LPCTSTR;
pszWindow: LPCTSTR;
fIndexOnFail: BOOL;
end;
HH_AKLINK = tagHH_AKLINK;
THHAKLink = tagHH_AKLINK;
Description:
The THHAKLink record is used to specify one or more ALink names or KLink keywords
that you want to search for using the HH_ALINK_LOOKUP and HH_KEYWORD_LOOKUP
respectively. It also allows you to specify the window in which the resulting topic
should be shown as well as what should happen if the lookup finds no matching topics.You
can specify one of these four things:
Member | Description |
---|---|
cbStruct | Must be set to the size of this record in bytes. Use the SizeOf operator before passing this record to the HtmlHelp function. Used for versioning. |
fReserved | Reserved. Must be set to False. |
pszKeywords | Specifies the keywords to serach for. Multiple keywords must be seperated by a semicolon, eg 'Keyword1;Keyword2' |
pszUrl | If fIndexOnFail is False then pszUrl specifies the URL of the topic to display when the lookup finds no matches. Note that this topic must be located in the helpfile specified by the pszFile parameter of the HtmlHelp function and that tge topic is displayed in the window specified by the pszWindow parameter |
pszMsgText | If fIndexOnFail is False and pszUrl is nil then this a message box is displayed when the lookup finds no matches. This member specifies the text you want to display in the messagebox. |
pszMsgTitle | If fIndexOnFail is False and pszUrl is nil then this a message box is displayed when the lookup finds no matches. This member specifies the caption of this messagebox. |
pszWindow | Specifies the window in which the found topic is displayed, in which the topic specified by pszUrl is displayed or the index tab is displayed when fIndexOnFail is True. |
fIndexOnFail | If fIndexOnFail is True then the index tab is shown when the lookup finds no matches. |
Notes:
If fIndexOnFail is False and pszUrl, pszMsgText and pszMsgTitle are nil then on lookup
failure the HtmlHelp function will return 0 but nothing else happens, no messagebox, no
topic shown and no Index tab shown.