HelpFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Miscellaneous WINDEV functions

HelpFile

Presentation

Example

Context-sensitive help

BuildAutomationVariant

Calling a DLL written in Visual Basic

Constants for managing the WLanguage types

Constants for sound management

Constants used by ExecutePresetAction

Constants used by the TraceStart function

EndAutomatedProcedure

InAndroidEmulatorMode

InAndroidMode

InAndroidSimulatorMode

InAppleWatchEmulatorMode

InAppleWatchMode

InAppleWatchSimulatorMode

InAutomaticTestMode

InBackgroundMode

InComponentMode

InDelayedProcedureMode

InPocketSimulatorMode

InPrelaunchedSessionMode

InReportsAndQueriesMode

InServiceMode

InSimulatorMode

InStoredProcedureMode

InSysNotificationMode

InTSEMode

InTestMode

InUMCMode

InUniversalWindowsAppMode

InUniversalWindowsAppSimulatorMode

InUniversalWindowsPlatformMode

InUniversalWindowsPlatformSimulatorMode

InVGAMode

InWebMode

InWebSocketServerGlobalServiceMode

InWebSocketServerMode

InWindowsPhoneEmulatorMode

InWindowsPhoneMode

InWindowsPhoneSimulatorMode

InWindowsStoreAppMode

InWindowsStoreAppSimulatorMode

OpenDocumentAsynchronous

StyleDrawCaptionGrayed

Voice commands in your applications

WHelp

WINDEVVersion

WLanguage procedure called by OpenDocumentAsynchronous

diffApply

diffCreate

Context-sensitive help

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

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")

// 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

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.

Component: wd270obj.dll