Print Help (QUHPRTH) API

The Print Help (QUHPRTH) API prints help information from help modules named when this API is called.

Restriction

This API is only valid in an interactive job. It cannot be run from a batch process.

Authorities and Locks

Library Authority

*READ

Panel Group Authority

*USE

Panel Group Lock

*SHRRD

Required Parameter Group

Help identifier array

INPUT; CHAR(*)

An array of the help identifiers to print. The list can contain up to 2000 items. Each item has two parts:

Qualified help panel group name

CHAR(20)

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

Help module name

CHAR(32)

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.

Number of help identifiers

INPUT; BINARY(4)

The number of help identifiers in the help identifier array parameter. The number must be between 1 and 2000.

Help title

INPUT; CHAR(55)

The title to print if no title is found in the help panel group object.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Error Messages