Vcl.OleCtrls.TOleControl.GetHelpContext

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

Delphi

function GetHelpContext(Member: string; var HelpCtx: Integer;
var HelpFile: string): Boolean;

C++

bool __fastcall GetHelpContext(System::UnicodeString Member, int &HelpCtx, System::UnicodeString &HelpFile);

プロパティ

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

説明

ActiveX コントロールのメンバーのヘルプコンテキストを取り出します。

GetHelpContext メソッドを呼び出すと,ActiveX コントロールのメンバーのヘルプコンテキストを取り出せます。

Member は ActiveX コントロールのプロパティ,メソッド,またはイベントの名前です。OCX コントロール自体のヘルプコンテキストを取り出すには,Member を nil(Delphi)または NULL(C++)に設定します。

HelpCtx は Member のヘルプコンテキスト識別子が格納される変数です。

HelpFile は HelpCtx を含むヘルプファイルの名前が格納される変数です。

ActiveX コントロールについての情報は,ITypeInfo インターフェースから取り出されます。詳細は,OLE.HLP ファイルの「ITypeInfo」を参照してください。

GetHelpContext は,Member が見つからない場合に false を返し,見つかった場合は true を返します。