ErrObject.HelpContext プロパティ

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

ErrObject.HelpContext プロパティ

ヘルプ ファイルのトピックのコンテキスト ID を含む Integer を返すか、または設定します。読み取り/書き込み。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Property HelpContext As
 Integer

Visual Basic (使用法)

Dim instance As ErrObject
Dim value As Integer

value = instance.HelpContext

instance.HelpContext = value

C#

public int HelpContext { get;
 set; }

C++

public:
property int HelpContext {
    int get ();
    void set (int Value);
}

J#

/** @property */
public int get_HelpContext ()

/** @property */
public void set_HelpContext (int
 Value)

JScript

public function get HelpContext
 () : int

public function set HelpContext
 (Value : int)

プロパティ値
ヘルプ ファイルのトピックのコンテキスト ID を含む Integer を返すか、または設定します。読み取り/書き込み。

解説

詳細については、Visual Basic のトピック「HelpContext プロパティ (Err オブジェクト)」を参照してください。

HelpContext プロパティは、アプリケーションの状況依存ヘルプを表示する場合に使用します。HelpFile にヘルプ ファイルが指定されている場合、HelpContext プロパティは、指定のヘルプ ファイルを自動的に表示するために使用されます。HelpFile プロパティおよび HelpContext プロパティが両方とも空である場合は、Number プロパティの値がチェックされます。Number プロパティの値が Visual Basic ランタイム エラー値に対応する場合は、エラーの Visual Basic ヘルプ コンテキスト ID が使用されます。Number プロパティの値が Visual Basic エラーに対応していない場合、Visual Basic ヘルプ ファイルの目次画面が表示されます。

メモ
一般的なエラーを処理するには、アプリケーションでルーチンを記述する必要があります。オブジェクトを使ってプログラミングする場合、そのオブジェクトのヘルプ ファイルを使って、エラー処理の質を高めたり、またはエラーが回復できないときにユーザーにわかりやすいメッセージを表示したりできます。

使用例

Err オブジェクトの HelpContext プロパティを使用して、Overflow エラーに対する Visual Basic ヘルプ トピックを表示する例を次に示します。

Visual Basic

Dim Msg As String
Err.Clear()
On Error Resume Next
   ' Suppress errors for demonstration purposes.
Err.Raise(6)   ' Generate "Overflow" error.
If Err.Number <> 0 Then
  Msg = "Press F1 or HELP to see " & Err.HelpFile
 & " topic for" & _
  " the following HelpContext: " & Err.HelpContext
  MsgBox(Msg, , "Error:")
End If

プラットフォーム

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
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
ErrObject クラス
ErrObject メンバ
Microsoft.VisualBasic 名前空間
その他の技術情報
HelpContext プロパティ (Err オブジェクト)
Err オブジェクト (Visual Basic)
Description プロパティ (Err オブジェクト)
ErrorToString 関数
HelpFile プロパティ (Err オブジェクト)
LastDllError プロパティ (Err オブジェクト)
Number プロパティ (Err オブジェクト)
Source プロパティ (Err オブジェクト)