ErrObject.HelpFile Propriété

Définition

Espace de noms:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Source:

ErrObject.vb

Retourne ou définit une expression String contenant le chemin qualifié complet à un fichier d'aide. En lecture/écriture.

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

Valeur de propriété

String

Retourne ou définit une expression String contenant le chemin qualifié complet à un fichier d'aide. En lecture/écriture.

Exemples

Cet exemple utilise la HelpFile propriété de l’objet Err pour démarrer le système d’aide. Par défaut, la HelpFile propriété 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

Remarques

Si un fichier d’aide est spécifié par la HelpFile propriété, il est automatiquement appelé lorsque l’utilisateur appuie sur la touche Aide (ou la touche F1) dans la boîte de dialogue du message d’erreur. Si la HelpContext propriété contient un ID de contexte valide pour le fichier spécifié, cette rubrique s’affiche automatiquement. Si aucune n’est HelpFile spécifiée, le fichier d’aide de 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 explicite à votre utilisateur si l’erreur n’est pas récupérable.

Voir aussi

• Err()
• ErrorToString()