Vcl.WinHelpViewer.IWinHelpTester.GetHelpStrings

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function GetHelpStrings(const ALink: String): TStringList;

C++

virtual System::Classes::TStringList* __fastcall GetHelpStrings(const System::UnicodeString ALink) = 0 ;

プロパティ

種類 可視性 ソース ユニット
function public
Vcl.WinHelpViewer.pas
Vcl.WinHelpViewer.hpp
Vcl.WinHelpViewer IWinHelpTester


説明

関連リンク名に一致するヘルプ文字列を抽出します。

GetHelpStrings は、指定された関連リンク ALink 名と一致するトピックの、ヘルプ文字列のリストを返します。 GetHelpStrings は、TStringList 型オブジェクト内のヘルプ文字列を返します。

TWinHelpViewer クラス(Vcl.WinHelpViewer ユニットの implementation セクションで実装されている)は、TWinHelpViewer.GetHelpStrings 関数内で GetHelpStrings を使用します。 Vcl.WinHelpViewer ユニットが、プログラムの uses セクションで指定されている場合、TWinHelpViewer.GetHelpStrings は、System.HelpIntfs.ICustomHelpViewer.GetHelpStrings 関数を実装します。

IWinHelpTester.CanShowALink 関数は、GetHelpStrings の前に呼び出さなければなりません。

WinHelpViewer ユニットは廃止予定です。 代わりに、Vcl.HtmlHelpViewer を使用してください。

WinHelpViewer ユニットは、Windows WinHelp 関数 API のラッパーを実装します。 Microsoft は、WinHelp を非推奨としています。

関連項目