This function enables the use of certain Microsoft HTML Help system commands. It can be used to call an entry point in an HTML help file (".chm" file).
This function is for customers who do not want to use the Adelia help file but a help file produced using online help software, such as RoboHELP®.
Context
Windows client.
Parameters
<WINDOW> |
|
Static name of a graphical object. |
ALPHA(n) |
FileName |
Name of the CHM help file. |
NUM_BIN_4 |
CmdNum |
1 (HH_INITIALIZE) 2 (HH_UNINITIALIZE) 3 (HH_CLOSE_ALL) 4 (HH_DISPLAY_INDEX) 5 (HH_DISPLAY_TOC) 6 (HH_DISPLAY_TOPIC) 7 (HH_HELP_CONTEXT) 8 (HH_SYNC) |
ALPHA(n) or |
Data item |
Command-related data (see the HTML Help documentation). |
BOOL |
OnDesktop |
Display on the desktop: *TRUE: The help window is displayed independently of the program window. *FALSE: The help window is displayed over the program window. |
BOOL |
ReturnCode |
Return code for the operation: *TRUE if the operation was completed successfully. *FALSE if it was not. |
Important: The HH_INITIALIZE and HH_UNINITIALIZE functions MUST be called at the start and end of the process, respectively. These functions must be called in the Visual application's launcher program (menu).
Example
CmdNum = 7 /* HH_HELP_CONTEXT
FileName = 'file.chm'
EntireParam = 5028 /* Identification number of the displayed help topic
OnDesktop = *TRUE
CALL_DLL 'VaToolBx.dll' 'VaToolBxHtmlHelp' ID_WIN0 FileName CmdNum EntireParam OnDesktop ReturnCode
Click below for more details on how to:
List of the VaToolBx functions by topic