SPOOLER Function

Returns spooler status information.

Syntax

SPOOLER(function{,line#/account})

Syntax Elements

function is a number, from 1 to 4. Each number identifies a different spooler function for which to return status information.

line#/account
is an line number or account name, depending on the value of function. If line# is omitted, a null value is used.

Operation

Status information for each function number is returned in the form of a dynamic array, comprising one or more multi-valued attributes. Information returned for each function number is described below.

See General Spooler Procedures.

function

line#/account

Operation

1

ignored

Returns the status information reported on the SP-STATUS screen. Each attribute corresponds to a separate form queue status line on the screen. Information is returned as values in the following format:

Queue name]Form type]Device number]Device type]Device status]# entries for this device]Page skip]XL]BLKSZ]DENZ]LBL

2

{account name}

Returns the status information reported on the SP-JOBS screen plus password information. The creation date and time are returned in internal format (days since December 31, 1967 and seconds past midnight, respectively). Each attribute corresponds to a separate job entry on the screen. Information is returned as values in the following format:

Queue name]Job#]Generating account]Generating line number]Creation date]Creation time]Current print status]Current options]Total job size]# copies to print]0]User-id]0

3

{line number}

Returns the current spooler assignment information for the current port.  The format of each attribute is as follows:

BasicPrintFile#]FormQname]Options]Copies]JobFileName

where:

  • BasicPrintFile# - is the number of the print file specified by the PRINT-ON statement in the program which sent the print job.

  • FormQname - is the assigned form queue.

  • Options - is the option(s) currently assigned.

  • Copies - is the number of copies assigned to be printed.

  • JobFileName - is the name of the file containing the print job.

Note

If a default print assignment is used, a null string is returned until at least one job has been queued for output.

4

{line number}

Returns any currently open, queued jobs for the current port.  The format of each attribute is as follows:

BasicPrintFile#]SpoolerPrintFile#]Size

where:

  • BasicPrintFile# - is the report number of the print file specified by the PRINT-ON statement in the program which sent the print job.

  • SpoolerPrintFile# - is the job number of the print file in he form queue.

  • Size - is the current size of the print job in bytes.

Example 1

INFO = SPOOLER(1)
CRT INFO

Returns information in the following format, as one or more attributes:

STANDARD]]2]Tape]No Device]0]1]0]]1024]1600]2]^

Example 2

INFO = SPOOLER(2)
CRT INFO

Returns information in the following format, as one or more attributes:

STANDARD]5]ENGLISH-TUTORIAL]21]9215]41093]Queued]P]23]1]0]daveh]0^

Example 3

INFO = SPOOLER(3)
CRT INFO

Returns the following type information in an attribute:

12]INVOICES]H]2

Example 4

INFO = SPOOLER(4)
CRT INFO

Returns information in the following format, as one or more attributes:

12]25]16505^