System.HelpIntfs.ICustomHelpViewer.GetHelpStrings
Delphi
function GetHelpStrings(const HelpString: string): TStringList;
C++
virtual System::Classes::TStringList* __fastcall GetHelpStrings(const System::UnicodeString HelpString) = 0 ;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | ICustomHelpViewer |
Description
Returns the Help Strings that match a keyword.
The Help System calls GetHelpStrings to obtain a list of Help Strings for topics that match a keyword-based Help request. GetHelpStrings should expect the keyword in the HelpString parameter and return the Help Strings in a TStringList object.
A Help String is an identifying string associated with a specific topic. The Help System requires that each of the topics provided by a given Viewer have a different Help String. The Help System does not require that two Viewers never use the same Help String, but an application should still avoid doing this. One strategy is to include the Viewer Name in the Help String.
The Help System uses Help Strings to provide the Help Selector with a merged list of Help topics that match a request. Typically, Help Strings are human-readable topic descriptions, and the Help Selector simply displays them to the user so the user can choose which topic will be displayed.
In order to use GetHelpStrings, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. For C++, you need to include the HTMLHelpViewer.hpp header file.