std_help()

The function displays any page of the Online Help, an arbitrary HTML page in the browser or an arbitrary text/pdf file on the computer resp. on a computer in the network.

Synopsis

void std_help(string keyword[, bool showChild = TRUE, string docNamespace = "WinCC_OA", string docPackage = "core", bool useLangFilter = TRUE]);

Parameters

Parameter Description
keyword

The following strings can be used with this parameter:

- Keyword that is used as a link to the Online Help (e.g. WinCC OA, CTRL) or a HTML file name with the extension ".htm"

- Internet address, which is opened in the browser. The extensions of the HTML pages can be htm|html|php|asp.

- Text file on the computer or in the network. File is opened with Notepad/Vi.

- pdf file on the computer or in the network. File is opened in the browser.
showChild

Optional parameter.

Opens a dialog with error message when a wrong or not existing keyword is used. Default: TRUE - a dialog will be opened.
docNamespace

Optional parameter.

Name of the compiled help file, which will be opened. If you do not define the optional parameter, the WinCC_OA.qhc is opened by default.
docPackage

Optional Parameter.

Name of the package to open. The default package is "core".
useLangFilter

Defines if a language filter is passed to the Qt assistant.

Filters provided and used with the installation are "en" (default), "de" and "ru". If no filter is used the content for all installed languages is displayed within the Qt assistant.

Return value

None

Errors

In case of incorrect keywords or path specifications of the file keywords.txt the required page is not opened.

Description

This function (see std.ctl) displays the appropriate help page. Under Windows HyperHelp (hh.exe) is used to display help pages, under Linux StartHelp. Furthermore you can specify an arbitrary URL, text or pdf file with the parameter keyword. The pages, which should be opened in the browser when defining an Internet address, can have the extension htm|html|php|asp. Text file has the extension .txt and pdf files .pdf.

The keyword is any desired word. If it is an HTML file name, then the keywords.txt is not used, otherwise this function looks in a file with the name keywords.txt, which must be located in the .../help/<LANG>/ directory. It contains pairs of:

"HTML Filename" "Keyword"

The user of this function specifies the keyword, which is searched for in every keywords.txt file in the search path. If it is found, the corresponding help page is displayed.

If the user uses Qt-compiled help files:

The compiled file must have the name core.qhc and must be located in the .../help/<LANG>/ directory.

The search for keywords.txt is hierarchically. You can use your own keywords.txt for your project.

i.e. there are:

  • help/<LANG>/keywords.txt all layers

  • help/keywords.txt all layers

  • <proj_path>/help/keywords.txt 1 layer

  • <wincc_oa_path>/help/keywords.txt 1 layer

All files are searched for the keyword. At the very first occurrence the according file in the directory help/<LANG>/WebHelp/ will be searched. If this does NOT exist, the first qhc file is used for the Online Help.

Example

Example of keywords.txt entry:

WinCC_OA.htm WinCC_OA

The corresponding std_help() call:

std_help("WinCC_OA");

Example

Example for opening an Internet address:

std_help("www.etm.at/index.htm");

Example

Example for opening a text file:

std_help("C:/WINNT/system32/eula.txt");

Example

Example for opening a pdf file (located on the computer "eid2k211" in the network):

std_help("file://eid2k211/GUI/GUI.pdf");

Assignment

Miscellaneous functions

Availability

CTRL