ErrObject.HelpContext Eigenschaft

Definition

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Quelle:

ErrObject.vb

Gibt eine Integer zurück, die die Kontext-ID für ein Thema in einer Hilfedatei enthält, oder legt diese fest. Lese-/Schreibzugriff.

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

public int HelpContext { get; set; }

member this.HelpContext : int with get, set

Public Property HelpContext As Integer

Eigenschaftswert

Int32

Gibt eine Integer zurück, die die Kontext-ID für ein Thema in einer Hilfedatei enthält, oder legt diese fest. Lese-/Schreibzugriff.

Beispiele

In diesem Beispiel wird die HelpContext -Eigenschaft des Err -Objekts verwendet, um das Visual Basic-Hilfethema für den Overflow Fehler anzuzeigen.

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

Die HelpContext -Eigenschaft wird verwendet, um kontextbezogene Hilfe für eine Anwendung anzuzeigen. Wenn eine Hilfedatei in HelpFileangegeben ist, wird die HelpContext -Eigenschaft verwendet, um die identifizierte Hilfedatei automatisch anzuzeigen. Wenn sowohl die HelpFile -Eigenschaft als HelpContext auch die -Eigenschaft leer sind, wird der Wert der Number -Eigenschaft überprüft. Wenn der Wert der Number Eigenschaft einem Visual Basic-Laufzeitfehlerwert entspricht, wird die Visual Basic-Hilfekontext-ID für den Fehler verwendet. Wenn der Wert der Number Eigenschaft nicht einem Visual Basic-Fehler entspricht, wird der Inhaltsbildschirm für 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()