HELP Action

This document covers the following topics:


Description

Invokes the help system and displays the help corresponding to the given help topic ID.

The name and location of the help file is determined by the HELP-FILENAME attribute for the specified dialog (or containing dialog if a dialog element is specified), rather than for the active dialog. In other words, the logic used is as described for the HELP-FILENAME attribute for context-sensitive help.

Parameters

Name/Data Type Explanation
HANDLE OF GUI Input

The dialog or dialog element acting as parent window for the help window. Must not be an item. This parameter is also used to retrieve any non-default help file name via dialog's HELP-FILENAME attribute.

Help ID (I4) Input

The help topic ID.

Response (I4) Output

Natural error (if applicable).

Example:

 #EA-1.HELP-ID := 1234 
   /*Set 1234 as help topic ID for the edit area 
   PROCESS GUI ACTION HELP WITH #EA-1 #EA-1.HELP-ID GIVING #RESPONSE