ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Miscellaneous WINDEV functions
  • Context-sensitive help
  • HLP format
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
HelpFile (Function)
In french: FichierAide
Returns or modifies the name of the help file used by the context-sensitive help of a window.
Example
// 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")
// 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 the help file (CHM file) associated with the context-sensitive help window.
<Window name>: Character string
Name of window whose associated help file you want to get. 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> [, <Help file name>])
<Result>: Character string
Name and path of the help file (CHM file) associated with the context-sensitive help window. 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.
<Help file name>: Optional character string
Name and path of help file (CHM file) used for context-sensitive help. A relative path or a UNC path can be used.
Remarks

Context-sensitive help

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.

HLP format

This function can also be used to manipulate HLP files for compatibility. This help file format is no longer supported by recent versions of Windows.
Component: wd300obj.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/13/2025

Send a report | Local help