ErrObject.HelpContext Propriété

Définition

Espace de noms:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Source:

ErrObject.vb

Retourne ou définit un Integer contenant l'ID de contexte pour une rubrique dans un fichier d'aide. En lecture/écriture.

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

Valeur de propriété

Int32

Retourne ou définit un Integer contenant l'ID de contexte pour une rubrique dans un fichier d'aide. En lecture/écriture.

Exemples

Cet exemple utilise la HelpContext propriété de l’objet Err pour afficher la rubrique d’aide de Visual Basic pour l’erreur Overflow .

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

Remarques

La HelpContext propriété est utilisée pour afficher l’aide contextuelle d’une application. Si un fichier d’aide est spécifié dans HelpFile, la HelpContext propriété est utilisée pour afficher automatiquement le fichier d’aide identifié. Si les HelpFile propriétés et HelpContext sont vides, la valeur de la Number propriété est cochée. Si la valeur de la Number propriété correspond à une valeur d’erreur d’exécution Visual Basic, l’ID de contexte de l’aide Visual Basic pour l’erreur est utilisé. Si la valeur de la Number propriété ne correspond pas à une erreur Visual Basic, l’écran de contenu du fichier d’aide visual Basic s’affiche.

Notes

Vous devez écrire des routines dans votre application pour gérer les erreurs classiques. Lors de la programmation avec un objet, vous pouvez utiliser le fichier d’aide de l’objet pour améliorer la qualité de votre gestion des erreurs, ou pour afficher un message significatif à votre utilisateur si l’erreur n’est pas récupérable.

Voir aussi

• Err()
• ErrorToString()