HelpFile, propriété (objet Err)

Mise à jour : novembre 2007

Retourne ou définit une expression String contenant le chemin d'accès complet vers un fichier d'aide. Lecture/écriture.

Public Property HelpFile() As String

Notes

Si un fichier d'aide est spécifié par la propriété HelpFile, il est automatiquement appelé lorsque l'utilisateur appuie sur la touche Aide (ou sur la touche F1) dans la boîte de dialogue de message d'erreur. Si la propriété HelpContext contient un ID de contexte valide pour le fichier spécifié, cette rubrique est automatiquement affichée. Si aucune propriété HelpFile n'est spécifiée, le 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é HelpFile de l'objet Err pour démarrer le système d'aide. Par défaut, la propriété HelpFile contient le nom du fichier d'aide de 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

Configuration requise

Espace de noms :Microsoft.VisualBasic

**Module :**ErrObject

**Assembly :**bibliothèque Visual Basic Runtime (dans Microsoft.VisualBasic.dll)

Voir aussi

Référence

Err, objet (Visual Basic)

Description, propriété (objet Err)

HelpContext, propriété (objet Err)

LastDllError, propriété (objet Err)

Number, propriété (objet Err)

Source, propriété (objet Err)