HELP Action

This document covers the following topics:


Description

Invokes the help system and points to the given help topic in the help file HELP-FILENAME determined by the attribute for the specified dialog, or libraryname.hlp if this has not been set. Natural expects the help file to be located in one of the directories listed in the desription of the HELP-FILENAME attribute.

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 dialogs 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