VB & VBA in a Nutshell: The Language

Err.HelpFile Property

Syntax

Err.HelpFile

Description

A read/write string property that contains the fully qualified path of a Windows Help file.

Rules at a Glance

• You can set a global Help file for the project in the project Properties dialog box, which can be accessed from the Tools menu in VB 4.0 and the Project menu in VB 5.0 and 6.0.

• The HelpFile property is automatically set by the Err object when an error is raised.

• The default help file is the Microsoft Visual Basic for Applications reference.

Example

See Err.HelpContext.

Programming Tips and Gotchas

• You can display a topic from the Visual Basic help file by using the MsgBox function with the vbMsgBoxHelpButton constant and passing Err.HelpFile as the HelpFile argument (as shown in the example for the Err.HelpContext property). While this is a simple and effective way to add more functionality to your applications, bear in mind that some of your users could find the explanations within the VB help file somewhat confusing. If time and budget allow, the best method is to create your own help file (for which you need the Help compiler and other Help file resources from the full version of VB), and pass both the HelpContext and HelpFileName to MsgBox.

• Another method of displaying the Help file is to call the Application.Help method, again passing both the Err.HelpFile and Err.HelpContext properties into the method, as follows:

  If Err.Number > 0 then
      Application.Help Err.HelpFile, Err.HelpContext
  End If

  This has the disadvantage ...