ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Miscellaneous WINDEV functions
  • Changing language and help file
  • Miscellaneous
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
WHelp (Function)
In french: WHelp
Displays a file or a help page in HLP or CHM format.
Example
// Open "NotePad.hlp" on the cut/paste page
WHelp("C:\Windows\NotePad.hlp", "PASTING TEXT")
// Open "NotePad.hlp" on the page whose context number is 35
// or on the index if the number does not exist
WHelp("C:\Windows\NotePad.hlp", 35)
Syntax

Opening the help about the help (WinHelp.hlp)

WHelp()

Opening a help file Hide the details

WHelp(<Name of help file> [, <Keyword>])
<Name of help file>: Character string
Name and path of help file (.HLP or .CHM). If the help file is not found, the function has no effect.
<Keyword>: Optional character string
Keyword used to find the help page.
This parameter corresponds to an empty string ("") or is not specified, the help file's index is opened and the user will be able to select the keyword he wants. If the help file has no index, the file is opened on the first help page.

Displaying a specific help page Hide the details

WHelp(<Name of help file> , <Context number>)
<Name of help file>: Character string
Name and path of help file (.HLP or .CHM). If the help file is not found, the function has no effect.
<Context number>: Integer
Context number associated with the help page and with the control for which the page must be displayed. The help number associated with a control is returned by NumHelp.
Remarks

Changing language and help file

In the WINDEV help editor, the name of the help file can be built from a numeric identifier corresponding to Nation.
In this case, to start the help file corresponding to the current language, all you have to do is use the following code:
// Start the help in CHM format
WHelp("MyFile" + NumToString(Nation(), "03d") + ".chm")

Miscellaneous

  • For more information about WinHelp, see the Windows documentation.
  • To associate a context-sensitive tooltip with the controls of a window, use HelpFile.
Component: wd290obj.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help