ErrObject.HelpFile Eigenschaft

Definition

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Quelle:

ErrObject.vb

Gibt einen String-Ausdruck zurück, der den vollqualifizierten Pfad zu einer Hilfedatei enthält, oder legt diesen fest. Lese-/Schreibzugriff.

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

Eigenschaftswert

String

Gibt einen String-Ausdruck zurück, der den vollqualifizierten Pfad zu einer Hilfedatei enthält, oder legt diesen fest. Lese-/Schreibzugriff.

Beispiele

In diesem Beispiel wird die HelpFile -Eigenschaft des Err -Objekts verwendet, um das Hilfesystem zu starten. Standardmäßig enthält die HelpFile -Eigenschaft den Namen der Visual Basic-Hilfedatei.

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

Hinweise

Wenn eine Hilfedatei von der HelpFile -Eigenschaft angegeben wird, wird sie automatisch aufgerufen, wenn der Benutzer die Hilfetaste (oder die F1-Taste) im Dialogfeld der Fehlermeldung drückt. Wenn die HelpContext -Eigenschaft eine gültige Kontext-ID für die angegebene Datei enthält, wird dieses Thema automatisch angezeigt. Wenn nein HelpFile angegeben ist, wird die Visual Basic-Hilfedatei angezeigt.

Hinweis

Sie sollten Routinen in Ihre Anwendung schreiben, um typische Fehler zu behandeln. Wenn Sie mit einem Objekt programmieren, können Sie die Hilfedatei des Objekts verwenden, um die Qualität der Fehlerbehandlung zu verbessern oder um dem Benutzer eine aussagekräftige Nachricht anzuzeigen, wenn der Fehler nicht wiederhergestellt werden kann.

Weitere Informationen

• Err()
• ErrorToString()