ErrObject.HelpFile プロパティ

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

ErrObject.HelpFile プロパティ

ヘルプ ファイルへの絶対パスを含む String 型の式を返すか、または設定します。読み取り/書き込み。

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

Visual Basic (宣言)

Public Property HelpFile As
 String

Visual Basic (使用法)

Dim instance As ErrObject
Dim value As String

value = instance.HelpFile

instance.HelpFile = value

C#

public string HelpFile { get;
 set; }

C++

public:
property String^ HelpFile {
    String^ get ();
    void set (String^ Value);
}

J#

/** @property */
public String get_HelpFile ()

/** @property */
public void set_HelpFile (String Value)

JScript

public function get HelpFile
 () : String

public function set HelpFile
 (Value : String)

プロパティ値
ヘルプ ファイルへの絶対パスを含む String 型の式を返すか、または設定します。読み取り/書き込み。

解説

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

ヘルプ ファイルが HelpFile プロパティによって指定されている場合は、エラー メッセージ ダイアログ ボックスでユーザーがヘルプ キー (F1 キー) を押すとそのファイルが自動的に呼び出されます。HelpContext プロパティに指定のファイルの有効なコンテキスト ID が指定されている場合、そのトピックが自動的に表示されます。HelpFile が指定されていない場合、Visual Basic ヘルプ ファイルが表示されます。

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

使用例

Err オブジェクトの HelpFile プロパティを使用してヘルプ システムを起動する例を次に示します。既定では、HelpFile プロパティには 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 名前空間
その他の技術情報
HelpFile プロパティ (Err オブジェクト)
Err オブジェクト (Visual Basic)
Description プロパティ (Err オブジェクト)
HelpContext プロパティ (Err オブジェクト)
LastDllError プロパティ (Err オブジェクト)
Number プロパティ (Err オブジェクト)
Source プロパティ (Err オブジェクト)