ErrObject.HelpFile Egenskap

Definition

Namnområde:

Microsoft.VisualBasic

Sammansättning:

Microsoft.VisualBasic.dll

Returnerar eller anger ett String uttryck som innehåller den fullständigt kvalificerade sökvägen till en hjälpfil. Läsning/skrivning.

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

Egenskapsvärde

String

Returnerar eller anger ett String uttryck som innehåller den fullständigt kvalificerade sökvägen till en hjälpfil. Läsning/skrivning.

Exempel

I det HelpFile här exemplet används -egenskapen för Err objektet för att starta hjälpsystemet. Som standard innehåller egenskapen HelpFile namnet på Visual Basic Hjälp-filen.

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

Kommentarer

Om en hjälpfil anges av HelpFile egenskapen anropas den automatiskt när användaren trycker på hjälpnyckeln (eller F1-nyckeln) i dialogrutan för felmeddelandet. Om egenskapen HelpContext innehåller ett giltigt kontext-ID för den angivna filen visas det ämnet automatiskt. Om ingen HelpFile har angetts visas Visual Basic Hjälp-filen.

Note

Du bör skriva rutiner i programmet för att hantera vanliga fel. När du programmerar med ett objekt kan du använda objektets hjälpfil för att förbättra kvaliteten på felhanteringen eller för att visa ett meningsfullt meddelande för användaren om felet inte kan återställas.

Se även

• Err()
• ErrorToString()