Err.HelpContext Property

Err.HelpContext Property

---

Class

Microsoft.VisualBasic.ErrObject

Syntax

     Dim result As Integer = Err.HelpContext 

Description

The HelpContext property gets or sets the ID number of the online help page associated with the active error, as found in the help file indicated by the Err.HelpFile property.

Usage at a Glance

• When a runtime error occurs, the HelpContext property is automatically assigned for standard Visual Basic and .NET errors.

• While you can assign the HelpContext property directly, the Err.Raise method is a better way to assign the values of a custom error.

• When errors occur that have both the HelpFile and HelpContext properties set, the user can press the F1 key from the standard Visual Basic error dialog box to view the related online help. You can also use these values to manually display online help related to an error.

• Help context IDs can be assigned to online help file pages as part of the design process for these files. See the documentation supplied with your online help development tool for information on setting these IDs.

See Also

Err Object, Err.HelpFile Property