EXCOUTPUT EXECUTE OUTPUT PARAMETER TAASPLV |
The Execute OUTPUT parameter command is designed for use by user
written DSP commands which support a standard OUTPUT parameter
(defaults to * and allows *PRINT). EXCOUTPUT provides either DSPSPLF
or RLSSPLF depending on the job type and the value of the OUTPUT
parameter.
For example, assume you have a DSP command such as:
DSPxxx ... OUTPUT(*)
Assume your HLL program creates a spooled file to the QPRINT printer
file. The CPP CL program would be coded as:
DCL &OUTPUT *CHAR LEN(6)
DCL &SPLF *CHAR LEN(10) VALUE(yyy)
.
OVRPRTF FILE(QPRINT) SPLFNAME(&SPLF) HOLD(*YES) +
USRDTA(DSPxxx)
CALL xxx /* Pgm to produce spooled file */
EXCOUTPUT SPLF(&SPLF) OUTPUT(&OUTPUT) +
MSG('DSPxxx completed normally. See +
' *CAT &SPLF *TCAT ' spooled file')
Note that the OVRPRTF command holds the spooled file so that it will
not be output by a print writer unless released by the EXCOUTPUT
command.
If your DSPxxx command is executed interactively with OUTPUT(*),
EXCOUTPUT will:
** Use DSPSPLF to display the spooled file.
** Delete the spooled file (the DLTSPLF parameter defaults to
*YES if the spooled file is displayed).
** The MSG value will not be sent as a completion message (this
is the system standard that if the user sees a display, no
completion message is sent).
If your DSPxxx command is executed in batch or with OUTPUT(*PRINT),
EXCOUTPUT will:
** Release the spooled file. If it is not held or does not exist
at that point, no error occurs.
** Use the MSG value to send a completion message. The
completion message is sent using CPF9898 and the value of the
MSG parameter is used as the MSGDTA for the CPF9898 message
ID. The message is sent using the QMHSNDPM API which sends it
up the stack to the 2nd program. It would appear as if your
CL program had sent the message.
Command parameters *CMD
------------------
SPLF The spooled file name to be displayed or released.
OUTPUT The type of output. This parameter is required and
would normally be passed the value from your DSPxxx
command OUTPUT parameter. The values are restricted
to * or *PRINT and have the same meaning as on
system commands.
DLTSPLF A *YES/*NO value for whether the spooled file should
be deleted if it was displayed. *YES is the
default. Note that this parameter is only used if
the spooled file is displayed.
MSG The text for a completion message if the spooled
file is not displayed. The text is used as message
data for the CPF9898 message ID which is sent using
the API QMHSNDPM to the 2nd higher program in the
stack. The intent of the API is to make it appear
as if the program which uses EXCOUTPUT has sent the
completion message.
Restrictions
------------
None.
Prerequisites
-------------
None.
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
EXCOUTPUT *CMD TAASPLV QATTCMD
TAASPLVC *PGM CLP TAASPLVC QATTCL
|
Added to TAA Productivity tools May 1, 1996