Spooler Programmer's Guide

Spooler Programmer’s Guide—522287-002

2-1

Using the Spooler Interface

Procedures

Application programs can spool jobs (that is, write the data for a spooler job) using a

group of procedures that act as an interface between an application program and a

collector process in a spooler subsystem. These procedures are usually referred to as

spooler interface procedures. This section describes how to use these procedures in

an application program.

Table 2-1 contains a summary of the spooler interface procedures. Section 4, Spooler

Procedure Calls, contains complete descriptions of the procedures and their

parameters. Refer to Appendix C, Spooler-Related Errors, for those error codes that

are relevant to spooler interface procedures, along with file-system errors that have

special significance for the spooler.

Table 2-1. Summary of Spooler Interface Procedures

Procedure Function

SPOOLBATCHNAME Returns the name of the spooler batch job currently being

spooled to the collector.

SPOOLCONTROL Replaces the Guardian file-system CONTROL procedure when

spooling at level 3.

SPOOLCONTROLBUF Replaces the Guardian file-system CONTROLBUF procedure

when spooling at level 3.

SPOOLEND Writes any remaining blocked data to the spooler and signals end

of job; can be used to modify the job attributes.

SPOOLERCOMMAND Issues a SPOOLCOM command to the supervisor.

SPOOLEREQUEST Obtains a Startup message from the supervisor suitable for

reading a job.

SPOOLEREQUEST2 Obtains a startup message from the supervisor suitable for

reading a job. Includes batch enhancements to

SPOOLEREQUEST.

SPOOLERSTATUS Obtains status of spooler components.

SPOOLERSTATUS2 Obtains status of spooler components. Includes batch

enhancements to SPOOLERSTATUS.

SPOOLJOBNUM Returns the job number of the job currently being spooled to the

collector.

SPOOLSETMODE Replaces the Guardian file-system SETMODE procedure when

spooling at level 3.

SPOOLSTART Specifies job attributes and optionally initializes a level-3 buffer.

SPOOLWRITE Compresses, blocks, and sends data to the spooler.