HelpFile Property

Applies To

Err object.

Description

Returns or sets a string expression the fully qualified path to a Microsoft Windows Help file. Read/write.

Remarks

If a Help file is specified in HelpFile, it is automatically called when the user presses the Help button (or the F1 key) in the error message dialog box. If the HelpContext property contains a valid context ID for the specified file, that topic is automatically displayed. If no HelpFile is specified, the Visual Basic Help file is displayed.

Note ou should write routines in your application to handle typical errors. When programming with an object, you can use the object's Help file to improve the quality of your error handling, or to display a meaningful message to your user if the error isn't recoverable.

See Also

Description property, Err object, HelpContext property, LastDLLError property, Number property, Source property.

Example

This example uses the HelpFile property of the Err object to start the Microsoft Windows Help system. By default, the HelpFile property contains the name of the Visual Basic Help file.

Dim Msg
Err.Clear
On Error Resume Next        ' Suppress errors for demonstration purposes.
Err.Raise 6                    ' Generate "Overflow" error.
Msg = "Press F1 or Help to see " & Err.HelpFile & _
    " topic for this error"
MsgBox Msg, , "Error: " & Err.Description,Err.HelpFile, Err.HelpContext