The SPOOLWRITE command writes data to a spool report.

SPOOLWRITE
>>-SPOOLWRITE--TOKEN(data-area)--FROM(data-area)---------------->
.--------------------.
.-LINE-. V |
>--+---------------------+--+------+----+-NOHANDLE-------+-+---><
'-FLENGTH(data-value)-' '-PAGE-' '-RESP-+-------+-'
'-RESP2-'
Conditions:
ALLOCERR, INVREQ, LENGERR, NOSPOOL, NOSTG, NOTOPEN, SPOLBUSY,
SPOLERR, STRELERR
Options
- FLENGTH(data-value)
- specifies the fullword binary variable that is to be set to the length
of the data that is transferred. This is set by the user on output. It is
optional and, if it is omitted, CICS® uses the length of the data area.
- FROM(data-area)
- specifies the data area from which to take the variable length data.
The data itself is not altered in any way by CICS. FROM is a sender field.
- LINE|PAGE
- specifies the format of the data to be sent. The default action is LINE.
The PAGE option must be used to correctly format information for the advanced
function printer (AFP) page printing devices. If
a customer is creating MIXED mode type data, that is LINE records and X'5A' (AFPDS or MODCA) pagemode records, the LINE or PAGE operand must
match the type record being written to spool.
- TOKEN(data-area)
- specifies the 8-character CICS-allocated token used to identify a report.
It is a receiver on SPOOLOPEN and a sender on all other commands.
Conditions
Note: There are no default actions.
- ALLOCERR
- occurs in any of the following situations:
- Dynamic allocation has rejected a request to allocate an input data set.
RESP2 gives the dynamic allocation response code that denotes this error.
The first two characters are the information reason code (S99INFO), and the
second two are the error reason code (S99ERROR), as defined in the z/OS®: MVS™ Programming: Authorized Assembler Services Guide, SA22-7608.
- INVREQ
- RESP2 values:
- 4
- Unsupported language.
- 8
- Unsupported function.
- 28
- FROM missing.
- 40
- Subsystem interface already enabled.
Note: Errors 1024 and
over are internal, and should not occur. If one of these error codes is returned,
contact your IBM® support center.
- LENGERR
- occurs in any of the following situations:
- NOSPOOL
- RESP2 values:
- 4
- No subsystem present.
- 8
- Interface being disabled; CICS is quiescing.
- 12
- Interface has been stopped.
- NOSTG
- occurs in any of the following situations:
- NOTOPEN
- RESP2 values:
- 8
- Spool report has not been opened.
- 16
- Attempt to write an input file.
- 1024
- Subtask OPEN macro failure.
- SPOLBUSY
- RESP2 values:
- 4
- Interface already in use by another task.
- 8
- Interface already in use by current task.
Also occurs (RESP2 not set) in the following situation:
- The JES/input single thread within the JES interface was not available.
- SPOLERR
- occurs in the following situation:
- STRELERR
- occurs in the following situation: