Vcl.WinHelpViewer.IWinHelpTester.GetHelpStrings
Delphi
function GetHelpStrings(const ALink: String): TStringList;
C++
virtual System::Classes::TStringList* __fastcall GetHelpStrings(const System::UnicodeString ALink) = 0 ;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Vcl.WinHelpViewer.pas Vcl.WinHelpViewer.hpp |
Vcl.WinHelpViewer | IWinHelpTester |
Description
Retrieves help strings that match the associative link name.
GetHelpStrings returns a list of help strings for topics that match the specified associative link ALink name. GetHelpStrings returns the help strings in the TStringList type object.
VCL does not provide an implementation of the IWinHelpTester interface. Therefore, if you need to use this function, you must implement IWinHelpTester in your application.
The TWinHelpViewer class, implemented in the implementation section of the Vcl.WinHelpViewer unit, uses GetHelpStrings in the TWinHelpViewer.GetHelpStrings function. TWinHelpViewer.GetHelpStrings implements the System.HelpIntfs.ICustomHelpViewer.GetHelpStrings function when you specify the Vcl.WinHelpViewer unit in the uses section of your program.
You should call the IWinHelpTester.CanShowALink function before GetHelpStrings.
The WinHelpViewer unit is deprecated. Use Vcl.HtmlHelpViewer instead.
The WinHelpViewer unit implements the wrapper for the Windows WinHelp function API. Microsoft has deprecated WinHelp.