View_Error_Help - HelpSystem
Displays an error help topic
Type: Procedure
Parameters
| Parameter | Type | Description |
|---|---|---|
| Obj | Integer | The object ID of the object that is requesting help |
Syntax
Procedure View_Error_Help Integer Obj
Call Example
Send View_Error_Help Obj
Description
The error handler normally sends this message. The help system will find a context value by sending the message context_help to the requesting object. The context returned will probably be the last error number. If a number is returned, the translation of this error number into a help-file context is handled by the help_object's Function system_help_error_ID.
Suggesting a default method for converting an error number into a context value is difficult. Using the error number as a context ID is not good because the error number can span a very large range. The default behavior of this function is to return the help_object Property help_ID_errors. This would load the "General Error Help" topic. It is then up to users to navigate within the help system to find the specific error. If you wish to support context error help at the error-number level, you will have to program this support yourself.