(Engine-Level Function)
| Description: | Enables you to enable or disable help file activation when the F1 key is pressed. |
| Returns: | Nothing |
Usage:  |
Script Only. |
| Function Groups: | Help |
| Related to: | Window | SetHelp |
| Format: |
EnableHelp(Enable, DefaultFileName) |
| Parameters: |
| Enable |
| Required. Controls whether F1 help is activated. If Enable is set to zero, F1 help activation is disabled. If Enable is set to 1, F1 help activation is enabled. |
| DefaultFileName |
| Required. The name of the Windows help file to be launched when the user presses the F1 key (if F1 help is activated using the Enable parameter above), and if no other help context can be found. This Windows help file is also the default help file that will be used when the user presses the Help button on the VTScada Application Manager (VAM). |
| Comments: | VTScada calls EnableHelp during startup using the settings of the Setup.ini configuration file variables "F1DisableHelp" and "WEBHelp" respectively. |
Example:
EnableHelp(PickValid(!F1DisableHelp, 1), WEBHelp);
Specify whether F1 help activation is enabled and the name of the default help file by setting the values of these variables in the Setup.ini configuration file.
