HtmlHelp | Window Functions

Cicode Programming Reference > Cicode Function Categories > Window Functions > HtmlHelp

HtmlHelp

Invokes the Microsoft HTML Help application (hh.exe) to display a specific topic from a specific HTML help file (.chm).

Syntax

HtmlHelp(sHelpFile, nCommand, sData)

sHelpFile:

The help file to display. For example: "C:\Program Files\Citect\CitectFacilities 7.30Schneider Electric\Vijeo Citect\Vijeo Citect 7.30Schneider Electric\PowerSCADA Expert 7.30\bin\CitectSCADA.chm"

nCommand:

The type of help:

0 - Display a topic identified by an internal file name in the sData field. This is the name of the file within the .chm file. For example: "Vijeo_CitectPowerLogic_SCADA_Help_Overview.html"

1 - Display a topic identified by the Mapped Topic ID in the sData field. For example: "1000"

2 - Terminate the help application

3 - Display the index

sData:

Optional data, depending on the value of nCommand. See above.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

WndHelp

Example

The following example displays the overview page of the Citect SCADA help:

HtmlHelp("C:\Program 
Files\Citect\CitectFacilities 7.30Schneider Electric\Vijeo Citect\Vijeo Citect 7.30Schneider Electric\PowerSCADA Expert 7.30
\bin\CitectSCADA.chm", 0, 
"Vijeo_CitectPowerLogic_SCADA_Help_Overview.html");