Progress
Help Development
Guide


The SYSTEM-HELP Statement

A Progress application executes the Windows help engine (Winhlp32.exe) using the SYSTEM-HELP statement. This is the syntax for the SYSTEM-HELP statement:

SYNTAX
SYSTEM-HELP file-string
  [ WINDOW-NAME window-name ]
  {  CONTEXT int-expr
    | CONTENTS
    | SET-CONTENTS int-expr
    | FINDER
    | CONTEXT-POPUP int-expr
    | KEY string
    | PARTIAL-KEY string
    | MULTIPLE-KEY char TEXT string
    | COMMAND string
    | POSITION X x Y y WIDTH dx HEIGHT dy
    | POSITION MAXIMIZE
    | FORCE-FILE
    | HELP
    | QUIT
  } 

file-string

The filestring parameter is a character expression that specifies the pathname of a help file. Help files have a .hlp file extension.

WINDOW-NAME window-name

The windowname parameter is a character expression that evaluates to the primary or secondary window name as defined in the [WINDOWS] section of the help project file. If the window name is omitted, or if “main” is specified, the primary help window is used.

CONTEXT intexpr

Displays the help topic that the context ID identifies. You define context IDs in the [MAP] section of the help project file.

The int-expr parameter is the context ID for the help topic.

CONTENTS

Displays the help topic defined as the contents in the [OPTIONS] section of the help project file.

Progress supports this option for backward compatibility with Windows 3.x (16-bit) help files. When calling help files compiled with the Help Workshop (32-bit), you should provide a contents file (.cnt) and use the FINDER option.

SETCONTENTS intexpr

Dynamically re-maps the contents help topic from what is defined in the [OPTIONS] section of the help project file. When a CONTENTS call is made, the new contents help topic is displayed.

The int-expr parameter is the context ID for the new contents help topic.

Progress supports this option for backward compatibility only.

FINDER

Displays the Help Topics dialog box, which contains an Index tab, a Find tab, and optionally a Contents tab, with the most recently used tab displayed on top.

If a contents file (.cnt) is present when you initially call the Help Topics dialog box, then the Contents tab displays on top. If a contents file is not present, then the dialog box displays with only the Index and Find tabs, and the Index tab is on top.

CONTEXTPOPUP intexpr

Displays the help topic in a popup window that the context ID identifies. If there is a non-scrolling region in the topic, the Windows Help Viewer displays only that region. You pair context IDs and topic IDs in the [MAP] section of the help project file.

The int-expr parameter is the context ID of the help topic.

KEY string

Displays the help topic matching the string found in the index keyword list. If there is more than one match, it displays the first topic containing the keyword. If there is no match or the string is omitted, it displays the Help Topics dialog box with the Index tab on top.

The string parameter is a character expression that evaluates to a keyword for the desired help topic.

PARTIALKEY string

Displays the help topic matching the string found in the keyword list. If there is more than one match, no match, or if the string is omitted, it displays the Help Topics dialog box with the Index tab on top.

The string parameter is a character expression that evaluates to a partial key for the desired help topic.

MULTIPLEKEY char TEXT string

Displays the help topic matching a keyword from an alternate keyword table.

The char parameter is a character expression that evaluates to the single character keyword table identifier for the required table.

The string parameter is a character expression that evaluates to the keyword that is located in the keyword table.

COMMAND string

Executes a help macro if the help file is already open.

The string parameter is a character expression that evaluates to the help macro to execute.

POSITION X x Y y WIDTH dx HEIGHT dy

Displays and positions the help window as specified. (The units are pixels.)

The x parameter is an integer expression that specifies the x coordinate for the help window.

The y parameter is an integer expression that specifies the y coordinate for the help window.

The dx parameter is an integer expression that specifies the width of the help window.

The dy parameter is an integer expression that specifies the height of the help window.

POSITION MAXIMIZE

Displays and maximizes the help window.

FORCEFILE

Ensures that the correct help file is open and displayed.

HELP

Displays the How to Use Help file.

QUIT

Informs the help application that help is no longer required. If no other applications are using help, the operating system closes the help viewer.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095