Control.ControlAccessibleObject.GetHelpTopic メソッド

.NET Framework クラス ライブラリ リファレンス

Control.ControlAccessibleObject.GetHelpTopic メソッド

このユーザー補助オブジェクトに関連付けられたヘルプ トピックの識別子と、ヘルプ ファイルへのパスを取得します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 GetHelpTopic ( _
    <OutAttribute> ByRef fileName As
 String _
) As Integer

Visual Basic (使用法)

Dim instance As ControlAccessibleObject
Dim fileName As String
Dim returnValue As Integer

returnValue = instance.GetHelpTopic(fileName)

C#

public override int GetHelpTopic (
    out string fileName
)

C++

public:
virtual int GetHelpTopic (
    [OutAttribute] String^% fileName
) override

J#

public int GetHelpTopic (
    /** @attribute OutAttribute() */ /** @ref */ String fileName
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

fileName

このメソッドが返されるときに、このユーザー補助オブジェクトに関連付けられたヘルプ ファイルへのパスを表す文字列を格納します。このパラメータは初期化せずに渡されます。

戻り値
ヘルプ トピックの識別子。ヘルプ トピックがない場合は -1。メソッドが返されたときに、fileName パラメータには、このユーザー補助オブジェクトに関連付けられたヘルプ ファイルへのパスが格納されます。ただし、IAccessible インターフェイスが指定されていない場合は null 参照 (Visual Basic では Nothing) が格納されます。

解説

この識別子を fileName パラメータで指定された WinHelp ファイルに渡し、目的のヘルプ トピックを指定します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
Control.ControlAccessibleObject クラス
Control.ControlAccessibleObject メンバ
System.Windows.Forms 名前空間