| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Printer device name | Input | Char(10) |
| 5 | Printer data stream type | Input | Char(10) |
| 6 | Type of separator page | Input | Char(10) |
| 7 | Qualified name of separator page program | Input | Char(20) |
| 8 | Writer handle | Input | Char(16) |
| 9 | Spooled file handle | Input | Char(10) |
| 10 | Drawer for separator page | Input | Binary(4) |
| 11 | Error code | I/O | Char(*) |
The Build Separator Pages (QSPBSEPP) API builds the system separator page to be printed for the spooled file. A user exit program is called to build the separator page or the system default is used. The separator page is returned in the receiver variable parameter. This data can then be sent to the printer. This API is only valid when called from a program that was called by a printer writer program. This API is not valid when called from a program that was called by a remote writer program.
If Build Separator Pages (QSPBSEPP) API encounters a problem when running a separator exit program, the default system separator will be returned. No error will be signalled or returned in the error code parameter.
If a qualified separator page program is specified or implied the user must have *EXECUTE authority to the program and the library the program is stored in.
The user must have *USE authority to the printer device description.
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
The length of the receiver variable. The amount of data is truncated if the receiver variable is too small. Anything less than 8 bytes is not valid.
The format of the information returned in the receiver variable.
The valid format name is:
| SEPP0100 | The formatted separator page data. |
The name of the printer device description for the writer that was started.
The type of data stream recognized by the printer writer. This is used to determine the type of data to generate for the separator page.
The valid special value is:
| *SCS | Systems Network Architecture (SNA) character string |
The type of separator page to be built.
Valid values are:
| *FILE | A file separator page is returned in the separator page data. This separator is printed before each copy of a spooled file. |
| *JOB | A job separator page is returned in the separator page data. This separator is printed between spooled files created by different jobs. |
The name of the separator page exit program to use to build the separator page. The first 10 characters contain the separator page program name and the second 10 characters contain the name of the library in which the separator page program is located.
The following special values are supported for the program name:
| *SYSDFT | The system default separator page is generated. |
| *DEVD | The separator program specified in the device description for the printer is used. |
The following special values are supported for the library name:
| *LIBL | The library list of the writer job is used to locate the message file. |
| *CURLIB | The current library for the writer job is used to locate the message file. |
The handle to the writer job. This handle is provided to the driver program on a writer call to the driver exit program at initialization time (the initialize option).
The spooled file handle to the current file that is being processed by the writer. This handle is provided to the driver program on a writer call to the driver exit program (using the process file option).
The following values are allowed:
| 0 | The separator drawer specified in the device description for the printer device name is used. |
| 1 - 255 | The drawer from which the separator page is printed. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table shows the information returned for the SEPP0100 format. For more details about the fields in the following table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to separator page data |
| 12 | C | BINARY(4) | Size of separator page data |
| 16 | 10 | CHAR(*) | Separator page data |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Offset to separator page data. The byte offset to the separator page data (from the beginning of the format).
Separator page data. The separator page data, which includes printer commands and the data to be printed.
Size of separator page data. The size of the separator page data, in bytes.
| Message ID | Error Message Text |
|---|---|
| CPF2207 E | Not authorized to use object &1 in library &3 type *&2. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF2702 E | Device description &1 not found. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C40 E | Spooled file &4 not found. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF33CC E | No writer found for specified handle &1. |
| CPF33CD E | No file found for specified handle &1. |
| CPF3309 E | No files named &1 are active. |
| CPF334C E | Value &1 not valid for print data stream type. |
| CPF334D E | Value &1 not valid for type of separator. |
| CPF334E E | Value &1 not valid for separator drawer. |
| CPF3344 E | File &1 number &2 no longer in the system. |
| CPF9810 E | Library &1 not found. |
| CPF9811 E | Program &1 in library &2 not found. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Print APIs | APIs by category ]