ErrObject.HelpFile 属性

定义

命名空间:

Microsoft.VisualBasic

程序集:

Microsoft.VisualBasic.Core.dll

Source:

ErrObject.vb

返回或设置一个 String 表达式，该表达式包含帮助文件的完全限定路径。 读/写。

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

public string HelpFile { get; set; }

member this.HelpFile : string with get, set

Public Property HelpFile As String

属性值

String

返回或设置一个 String 表达式，该表达式包含帮助文件的完全限定路径。 读/写。

示例

此示例使用 HelpFile 对象的 属性 Err 启动帮助系统。 默认情况下， HelpFile 属性包含 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

注解

如果帮助文件由 HelpFile 属性指定，当用户在错误消息对话框中按帮助键 (或 F1 键) 时，会自动调用它。 HelpContext如果 属性包含指定文件的有效上下文 ID，则会自动显示该主题。 HelpFile如果未指定，则显示 Visual Basic 帮助文件。

注意

应在应用程序中编写例程来处理典型错误。 使用 对象编程时，可以使用对象的帮助文件来提高错误处理的质量，或者在错误不可恢复时向用户显示有意义的消息。

另请参阅

• Err()
• ErrorToString()