Options
- ALTERNATE
- sets
the terminal to use the ALTERNATE screen size.
- ATTACHID(name)
- specifies
that an attach header (created by a BUILD ATTACH command) is to precede, and
be concatenated with, the user data supplied in the FROM option. “name” (1–8
characters) identifies the attach header control block to be used in the local
task.
- CNOTCOMPL
- indicates
that the request/response unit (RU) sent as a result of this SEND command
does not complete the chain. If this option is omitted and chain assembly
has been specified, the RU terminates the chain.
- CONFIRM
- indicates
that an application using a synchronization level 1 or 2 conversation requires
a response from the remote application. A remote CICS® application can respond positively
by executing an ISSUE CONFIRMATION command, or negatively, by executing an
ISSUE ERROR command, in which case the sending application has EIBERR and
EIBERRCD set. CICS does not return control to the sending application until
the response is received.
- CONVID(name)
- identifies
the conversation to which the command relates. The 4-character name identifies
either the token returned by a previously executed ALLOCATE command in EIBRSRCE
in the EIB, or the token representing the principal session (returned by a
previously executed ASSIGN command).
For compatibility with earlier releases,
SESSION is accepted as a synonym for CONVID. New programs should use CONVID.
If
this option is omitted, the principal facility is assumed.
- CTLCHAR(data-value)
- specifies
a 1-byte write control character (WCC) that controls a SEND command for a
3270. These are documented in the IBM 3270 Data Stream Programmer's
Reference. A COBOL user must specify a data area containing this character.
If the option is omitted, all modified data tags are reset to zero and the
keyboard is restored.
- DEFAULT
- sets
the terminal to use the DEFAULT screen size.
- DEFRESP
- indicates
that a definite response is required when the output operation has been completed.
- ERASE
- specifies
that the screen printer buffer or partition is to be erased and the cursor
returned to the upper left corner of the screen. (This option applies only
to the 3270, or 8775, and to the 3604 Keyboard Display.)
The first output
operation in any transaction, or in a series of pseudoconversational transactions,
should always specify ERASE. For transactions attached to 3270 screens or
printers, unless explicitly overridden by the DEFAULT or ALTERNATE option,
this also ensures that the correct screen size is selected, as defined for
the transaction by the SCRNSIZE option in the RDO PROFILE resource definition.
- FLENGTH(data-value)
An alternative to LENGTH. For architectural reasons, this option
is limited to a maximum of 32K for all terminal-related SEND commands.
- FMH
- specifies
that a function management header has been included in the data to be written.
If the ATTACHID option is specified as well, the concatenated FMH flag is
set in the attach FMH.
The use of FMH is optional and is not supported
for all terminal types. If not supplied, CICS takes no action, except for
3600/4700 terminals, where an FMH is mandatory. In this case, if FMH is not
specified, CICS supplies one and places it in the first 3 bytes of the message,
which you must reserve for this purpose.
- FROM(data-area)
- specifies
the data to be written to the logical unit, or a partner transaction.
- INVITE
- For
the SEND (APPC) command, INVITE allows an application program to add a change-direction
indicator to data already sent to a process in a connected APPC system. Control
data is not transmitted by CICS until the subsequent execution of a WAIT or
a SYNCPOINT command, unless CONFIRM or WAIT is also coded on the GDS SEND
INVITE command.
For the other SEND commands, INVITE specifies that the
next terminal control command executed for this facility is a RECEIVE. This
allows optimal flows to occur.
- LAST
- specifies
that this is the last SEND command for a transaction.
- LDC(name)
- specifies
the 2-character mnemonic used to determine the appropriate logical device
code (LDC) numeric value. The mnemonic represents an LDC entry in the terminal
control table TYPE=LDC.
- LENGTH(data-value)
- specifies
the length, as a halfword binary value, of the data to be written. For a description
of a safe upper limit, see LENGTH options in CICS commands.
- SESSION(name)
- specifies
the symbolic identifier (1–4 characters) of a session TCTTE. This option specifies
the alternate facility to be used. If this option is omitted, the principal
facility for the task is used.
- STATE(cvda)
- gets the state of the current
conversation. The cvda values returned by CICS are:
- ALLOCATED
- CONFFREE
- CONFRECEIVE
- CONFSEND
- FREE
- PENDFREE
- PENDRECEIVE
- RECEIVE
- ROLLBACK
- SEND
- SYNCFREE
- SYNCRECEIVE
- SYNCSEND
- STRFIELD
- specifies
that the data area specified in the FROM option contains structured fields.
If this option is specified, the contents of all structured fields must be
handled by the application program. The CONVERSE command, rather than a SEND
command, must be used if the data area contains a read partition structured
field. (Structured fields are described in the CICS 3270 Data Stream
Device Guide.)
CTLCHAR and ERASE are mutually exclusive with STRFIELD,
and their use with STRFIELD generates an error message.
- WAIT
- specifies
that processing of the command must be completed before any subsequent processing
is attempted.
If the WAIT option is not specified, control is returned
to the application program when processing of the command has started. A subsequent
input or output request (terminal control, BMS, or batch data interchange)
to the terminal associated with the task causes the application program to
wait until the previous request has been completed.
Conditions
Some
of the following conditions may occur in combination. If more than one occurs,
only the first is passed to the application program. EIBRCODE, however, is
set to indicate all the conditions that occurred.
- CBIDERR
- occurs
if the requested attach header control block named in ATTACHID cannot be found.
Default action: terminate the task abnormally.
- IGREQCD
- occurs
when an attempt is made to execute a SEND command after a SIGNAL data-flow
control command with a request change direction (RCD) code has been received
from the logical unit.
Default action: terminate the task abnormally.
- INVREQ
- RESP2 values:
- 200
- A distributed program link server application attempted to send on its
function-shipping session (its principal facility).
For SEND (APPC), a
distributed program link server application specified the function-shipping
session (its principal facility) on the CONVID option.
also occurs (RESP2 not set) in any of the following situations:
- The CONFIRM option has been specified, but the APPC conversation is not
sync level 1 or 2.
- The SEND command has been used on an APPC conversation that is not a mapped
conversation or that is not using the EXEC CICS interface.
Default action: terminate the task abnormally.
- LENGERR
- occurs
if an out-of-range value is supplied in the LENGTH or FLENGTH option.
Default
action: terminate the task abnormally.
- NOTALLOC
- occurs
if the CONVID value in the command does not relate to a conversation that
is owned by the application, or if the facility specified in the command is
not owned by the application.
Default action: terminate the task abnormally.
- SIGNAL
- occurs
when an inbound SIGNAL data-flow control command has been received from a
logical unit or session. EIBSIG is always set when an inbound signal is received.
Default action: ignore the condition.
- TERMERR
- occurs
for a session-related error. Any action on that conversation other than a
FREE causes an ATCV abend.
A CANCEL TASK request by a user node error
program (NEP) may cause this condition if the task has an outstanding terminal
control request active when the node abnormal condition program handles the
session error.
Default action: terminate the task abnormally with
abend code ATNI.