| Err.HelpContext Property |
Syntax
Err.HelpContext
Description
A read/write property that either sets or returns a long integer value containing the context ID of the appropriate topic within a Help file.
Rules at a Glance
The Err object sets the HelpContext property automatically when an error is raised.
If the error is user-defined, and you don't explicitly set the HelpContext property yourself, the Err object sets the value to 1000095, which corresponds to the "Application-defined or object-defined error" help topic in the VBA Help file. (The HelpContext property is set by the fifth parameter to the Err.Raise method.)
HelpContext IDs are decided upon when writing and creating a Windows help file. Once the Help file has been compiled, the IDs can't be changed. Each ID points to a separate Help topic.
Example
Sub TestErr()
On Error GoTo TestErr_Err
Dim i
i = 8
MsgBox (i / 0)
TestErr_Exit:
Exit Sub
TestErr_Err:
MsgBox Err.Description, vbMsgBoxHelpButton, "ErrorVille", _
Err.HelpFile, Err.HelpContext
Resume TestErr_Exit
End Sub
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.HelpContext as the HelpContext argument (as shown in the previous example). While this is a simple and effective way to add much 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 ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access