Designates the Help file that is to replace WINHELP.HLP, the How To Use Help file provided with Windows Help version 3.1. The replacement file opens when the user chooses the How To Use Help command or presses F1 in Windows Help.
Syntax
SetHelpOnFile("filename")
Parameter | Description |
filename | Name of the replacement How To Use Help file. The filename must be enclosed in quotation marks. |
Example
The following macro sets the How To Use Help file as QUIKHELP.HLP:
SetHelpOnFile("quikhelp.hlp")
To ensure that the How To Use Help file is always displayed in the main Help window, add the window name “main” to the macro and place the macro in the [CONFIG] section of the Help project file, as in this example:
[CONFIG]
SetHelpOnFile("quikhelp.hlp>main")
Comments
If Windows Help cannot find the Help file, it displays an error message.
If this macro appears within a topic in the Help file, the replacement Help file is set after execution of the macro. If this macro appears in the [CONFIG] section of the Help project file, the replacement Help file is set when the Help file is opened.
If this macro is executed from a secondary window, the replacement file will appear in the secondary window.
If you use this macro to replace the default How To Use Help file, executing the HelpOn macro will display the custom version of How To Use Help.
See Also
HelpOn, JumpHelpOn