$PSCALL OPT=HEADER

Adds header lines to an open print request.

&CONTROL SHRVARS=($PS)
-EXEC $PSCALL    OPT=HEADER
                 REQ=n
               [ SKIP={ 0 | 1 | 2 | 3 }  ]
               [ USCORE={ 1 | 2 } ]
               [ ALIGN={ LEFT | RIGHT | CENTER }  ]
               [ BOLD={ YES | NO } ]
               [ TOTAL=n ]

Prints a heading at the top of each page of output for a print request. The lines of text that are to be printed as the heading on each page need only be specified once, rather than each time a new page is requested. The header lines will be printed at the top of each new page.

Operands:

OPT=HEADER

Specifies that header lines are to be added to an open print request.

REQ=n

Specifies the number of the print request to which the header lines are to be added.

SKIP={ 0 | 1 | 2 | 3 }

Specifies the number of lines to be advanced before printing each header line. The default is 1.

USCORE={ 1 | 2 }

Specifies whether the text in each header line is to be underlined:

1: Specifies that text excluding the blanks between words is to be underlined.
2: Specifies that text including the blanks between words is to be underlined.

ALIGN={ LEFT | RIGHT | CENTER }

Specifies whether the text in each header line is to be aligned. The length used to align the text is the value defined in the Columns per Page field (width) for the printer.

BOLD={ YES | NO }

Specifies whether the text in each header line is to be bolded. The default is NO.

TOTAL=n

Specifies the number of variables containing header lines that are to be added to the print request. The valid range is 1 to 30. The default is 1.

Variables:

&$PSDATAn: Must be set to the header line of header text that is to be printed. n must be in the range 1 to 30. To print the page number in the heading, the variable must contain the characters &$PSP#.

Return Codes:

0

$PSCALL completed successfully.

4

$PSCALL completed successfully. The request was denied. &SYSMSG is set to an error message and &$PSFDBK is set to the following value:

17: The print request is not open.

8

An error occurred. &SYSMSG is set to an error message.

Example: OPT=HEADER

&CONTROL SHRVARS=($PS) 
&TEMP = &CONCAT & $PSP# 
&$PSDATA1 = &ASISTR Page=&TEMP
-EXEC $PSCALL OPT=HEADER REQ=342 SKIP=0 BOLD=NO TOTAL=1
&$PSDATA1 = &STR Title Line 1 
&$PSDATA2 = &STR Title Line 2 
-EXEC $PSCALL OPT=HEADER REQ=342 SKIP=1 BOLD=YES TOTAL=2

Notes:

When OPT=HEADER is specified, the header data passed is appended to the current header. If the previous call was not an OPT=HEADER, this will reset the header. This option allows a print request to contain numerous headers. The maximum number of text lines per header is 30.

A header is only physically printed when a form feed is done as the result of SKIP=NEWPAGE being specified on an OPT=PUT call, or when the lines per page defined for the printer is reached.