| 1 | Help identifier array | Input | Char(*) |
| 2 | Number of help identifiers | Input | Binary(4) |
| 3 | Help title | Input | CHAR(55) |
| 4 | Error code | I/O | Char(*) |
The Print Help (QUHPRTH) API prints help information from help modules named when this API is called.
This API is only valid in an interactive job. It cannot be run from a batch process.
An array of the help identifiers to print. The list can contain up to 2000 items. Each item has two parts:
The panel group (*PNLGRP) object that contains the help module to be printed, and the library in which it is located. (A panel group is an object with an object type of *PNLGRP. It contains display panels, print panels, or help modules.)
The first 10 characters contain the panel group object name, and the second 10 characters contain the library name. You can use these special values for the library name:
| *CURLIB | The job's current library |
| *LIBL | The library list |
The name specified on the NAME attribute of a :HELP. tag in the panel group object. The name must be specified using uppercase, alphabetic characters.
The number of help identifiers in the help identifier array parameter. The number must be between 1 and 2000.
The title to print if no title is found in the help panel group object.
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF6A24 E | Parameter &1 not passed correctly. |
| CPF6A25 E | Return code length of &1 not valid. |
| CPF6Exx E | All CPF6Exx messages could be signalled. xx is from 01 to FF. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | User Interface Manager APIs | APIs by category ]