HelpContext, propriété (objet Err)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne ou définit une valeur de type Integer contenant l'ID de contexte d'une rubrique de fichier d'aide. Lecture/écriture.

Public Property HelpContext() As Integer

Notes

La propriété HelpContext permet d'afficher l'aide contextuelle d'une application. Si un fichier d'aide est spécifié dans HelpFile, la propriété HelpContext permet d'afficher automatiquement le fichier d'aide identifié. Si les propriétés HelpFile et HelpContext sont vides, la valeur de la propriété Number est vérifiée. Si la valeur de la propriété Number correspond à une valeur d'erreur d'exécution Visual Basic, c'est l'ID de contexte d'aide Visual Basic de cette erreur qui est utilisé. Si la valeur de la propriété Number ne correspond pas à une erreur Visual Basic, l'écran du sommaire du fichier d'aide de Visual Basic s'affiche.

Remarque :
Vous devez écrire des routines dans votre application pour gérer les erreurs courantes. Pour 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 bien pour afficher un message significatif à l'attention de l'utilisateur si l'erreur n'est pas récupérable.

Exemple

Cet exemple utilise la propriété HelpContext de l'objet Err pour afficher la rubrique d'aide Visual Basic correspondant à 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