| [Overview][Types][Classes][Procedures and functions][Index] |
Populates the list with help nodes using the KeywordPrefix for the HTML help database.
Source position: lazhelphtml.pas line 70
public function THTMLHelpDatabase.GetNodesForKeyword( |
const HelpKeyword: string; |
var ListOfNodes: THelpNodeQueryList; |
var ErrMsg: string |
):TShowHelpResult; override; |
HelpKeyword |
|
Help keyword to locate in the HTML help database. |
ListOfNodes |
|
List used to store help nodes matching the keyword prefix and keyword value. |
ErrMsg |
|
Describes an error condition encountered in the help display requested. |
Status of the help display request.
GetNodesForKeyword is an overridden TShowHelpResult function used to populate the ListOfNotes parameter with the help nodes using the specified help keyword.
HelpKeyword contains the help keyword to locate in nodes for the HTML help database.
ListOfNodes is a THelpNodeQueryList instance which is populated in the method.
ErrMsg describes any error condition for the return value in the method.
GetNodesForKeyword calls the inherited method using the values in HelpKeyword, ListOfNodes, and ErrMsg as arguments. The return value is set to the TShowHelpResult enumeration value returned from the inherited method. No additional actions are performed in the method when the return value is not shrSuccess.
GetNodesForKeyword ensures that a THelpNode is included in ListOfNodes for the default topic matching the KeywordPrefix used in the HTML help database. GetNodesForKeyword calls CreateNodeQueryListAndAdd to populate the help nodes starting with the node for the Keyword prefix.
Please note that the list of node is populated at run-time only; the list is not populated at design-time.
| Version 3.2 | Generated 2024-02-25 | Home |