Returns or modifies the name of the help file used by the context-sensitive help of a window.
// Use the "D:\WINDEV\Help\Help.chm" help file
// for the context-sensitive help of "WIN_Window1"
HelpFile(WIN_Window1, "D:\WINDEV\Help\Help.chm")
// Use the "Help.hlp" help file
// for the context-sensitive help of the current window
HelpFile("", "Help.hlp")
// Find out the help file used
// for the context-sensitive help of the current window
ResHelpFile = HelpFile("")
Syntax
Finding out the name of help file used for the context-sensitive help Hide the details
<Result> = HelpFile(<Window name>)
<Result>: Character string
Name and path of help file (.HLP or .CHM) associated with the window for the context-sensitive help.
<Window name>: Character string
Name of window whose associated help file is requested. If this parameter corresponds to an empty string (""), the window used is the window to which the current process belongs.
Modifying the help file used for the context-sensitive help Hide the details
<Result> = HelpFile(<Window name> [, <Name of help file>])
<Result>: Character string
Name and path of help file (.HLP or .CHM) associated with the window for the context-sensitive help before modification.
<Window name>: Character string
Name of the window used. If this parameter corresponds to an empty string (""), the window used is the window to which the current process belongs.
<Name of help file>: Optional character string
Name and path of help file (.HLP or .CHM) used for the context-sensitive help. A relative path or a UNC path can be used.
Remarks
The context-sensitive help is displayed when the user clicks the "What is it" icon in the window (? icon).
This context-sensitive help is based:
- On the window style ("Icon of context-sensitive help" checked).
- On the file for context-sensitive help defined:
- in the window editor ("Help" tab in the description window of window).
- by HelpFile.
- On the help number defined in the control description.