Help

(Engine-Level Function)

Description	Calls a topic in a help system.
Returns	Nothing
Usage	Script Only.
Function Groups	Help
Related to:	SetHelp
Format	Help(FileName, Option, SearchValue)
Parameters

FileName

Required. Any text expression for the name of the help system to display. May be the name of a .CHM file. To call a topic in the VTScada help system, use the system property, \DevHelpFile. Refer to the comments section for more options.

Option

Required. Any numeric expression controlling how the topic will be located within the help system, as indicated by the following table. Not all options work with all help system formats. Calls to topics using context sensitive help ID values should use option 3. Option Display Option SearchValue 0 Help contents  0 1 Key  Key string 2 Partial key  Partial key string 3 ID  ID number 4 Help Topics  0

SearchValue

Required. Any expression that provides the proper qualification needed by the Option parameter as indicated by the preceding table.

Comments

If calling a help system compiled using the DocToHelp NetHelp system, use the string, "MyHelpfolder\NetHelp". If calling your own help system compiled using the Flare HTML5 system, use the string "MyHelpFolder\MadCapWebHelp". DocToHelp and Flare are products of Madcap Software Ltd. and are recognized by VTScada. The .HLP format is obsolete and will not open in modern versions of Windows.

Example:

  If ZButton(10, 40, 110, 10, "Help", 1);
  [
    Help("C:\VTScada\MyCustomHelpFile.chm", 0, 0); 
  ]

This displays a button on the screen that when pressed, opens the table of contents of the named CHM format file.

 

  If WinButton(513, 135, 547, 101,
               0                      { normal appearance },
               "?"                                { label },
               1                { focus id enables button },
               0                    { default system font },
               Invalid                { no ToggleVal used },
               Invalid     { image displayed in the button});
  [
    Help(\DevHelpFile, 3, 10180);
  ]

This will display a button that when pressed will open topic id 10180 in the VTScada help system.