Send device controls to a terminal without map or text data.
The keywords are separated into those supported by minimum, standard, and
full BMS. For further information about BMS, see the CICS® Application Programming Guide.
Description
SEND CONTROL sends device controls
to a terminal.
When using the SEND CONTROL command with any of the
ALARM, FREEKB, FRSET, HONEOM, L40, L64, L80, or PRINT options, see DFHMDI
options, CTRL for a description of the option priority.
- ACCUM
- specifies
that this command is one of a number of commands that are used to build a
logical message. The logical message is completed by a SEND PAGE command,
or deleted by a PURGE MESSAGE command.
- ACTPARTN(name)
- specifies
the name (1–2 characters) of the partition to be activated. Activating a partition
moves the cursor into the specified partition, and unlocks the keyboard for
the specified partition.
This option is ignored if the target terminal
does not support partitions, or if there is no application partition set.
- ALARM
- specifies
that the 3270 audible alarm feature is to be activated. For logical units
supporting FMHs (except interactive and batch logical units), ALARM instructs
BMS to set the alarm flag in the FMH.
- ALTERNATE
- sets
the terminal to use the ALTERNATE screen size.
- CURSOR(data-value)
- specifies
the location the 3270 or 3604 cursor is returned to on completion of a SEND
CONTROL command.
The data value must be a halfword binary value that specifies
the cursor position relative to zero; the range of values that can be specified
depends on the size of the screen being used.
If ACCUM is being used,
the most recent value of CURSOR specified is used to position the cursor.
The
value specified in the CURSOR option must be positive. A negative value leads
to unpredictable results.
If this option is omitted, the cursor is
positioned at position zero of the screen.
- DEFAULT
- sets
the terminal to use the DEFAULT screen size.
- 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 definition.
- ERASEAUP
- specifies
that all unprotected character locations in the partition or the entire screen
are to be erased. (This option applies only to the 3270 and 8775.)
- FORMFEED
- specifies
that a new page is required. For 3270 printers and displays, the FORMFEED
character is positioned at the start of the buffer. The application program
must thus ensure that this buffer position is not overwritten by map or text
data. It is ignored if the target terminal does not support FORMFEED (that
is, the RDO TYPETERM option FORMFEED was not used).
- FREEKB
- specifies
that the 3270 keyboard is to be unlocked. If FREEKB is omitted, the keyboard
remains locked.
Note that the keyboard lock status is maintained separately
for each partition on a terminal that supports partitions.
- FRSET
- specifies
that the modified data tags (MDTs) of all fields currently in the 3270 (or
partition) buffer are to be reset to the unmodified condition (that is, field
reset).
This allows the ATTRB operand of DFHMDF for the next requested
map to control the final status of fields written or rewritten in response
to a BMS command, if no other attribute information has been written in the
symbolic map.
- HONEOM
- specifies
that the default printer line length is to be used. This length should be
the same as that specified using the RDO TYPETERM options PAGESIZE or ALTPAGE.
- LAST
- specifies
that this is the last output operation for a transaction and, therefore, the
end of a bracket. This option applies to logical units only.
- LDC(name)
- specifies
a 2-character mnemonic to be used to determine the logical device code (LDC)
to be transmitted in the FMH to the logical unit. The mnemonic identifies
an LDC entry defined by a DFHTCT TYPE=LDC macro. When an LDC is specified,
BMS uses the device type, the page size, and the page status associated with
the LDC mnemonic to format the message. These values are taken from the extended
local LDC table for the LU, if it has one. If the LU has only a local (unextended)
LDC table, the values are taken from the system LDC table. The numeric value
of the LDC is obtained from the local LDC table, unless this is an unextended
table and the value is not specified, in which case it is taken from the system
table.
- L40, L64, or L80
- specifies
the line length for a 3270 printer; a carrier return and line feed are forced
after 40, 64, or 80 characters have been printed on a line. Unacceptable results
are likely if this differs from the page width specified by the RDO TYPETERM
options PAGESIZE or ALTPAGE.
When using the options, refer to DFHMDI
options, CTRL for a description of the option priority.
- MSR(data-value)
- specifies
the 4-byte data value that controls the 10/63 magnetic stripe reader attached
to an 8775 or 3643 terminal. A set of constants is provided in DFHMSRCA to
assist in setting this 4-byte area. See Magnetic slot reader (MSR) control value constants, DFHMSRCA for a complete list. This option is ignored if the RDO
TYPETERM option MSRCONTROL was not used.
- OUTPARTN(name)
- specifies
the name (1–2 characters) of the partition to which data is to be sent. This
option is ignored if the terminal does not support partitions, or if there
is no application partition set associated with the terminal. If there is
an application partition set, and the OUTPARTN option is omitted, data is
sent to the partition named by the PARTN operand of the DFHMSD (see DFHMSD) or the DFHMDI
(see DFHMDI)
map definition macros. If maps are not used, or if there is no PARTN operand,
the output is sent to the first partition in the partition set.
- PAGING
- specifies
that the output data is not to be sent immediately to the terminal, but is
to be placed in temporary storage and displayed in response to paging commands
entered by the terminal operator.
If PAGING is specified with a REQID
that is defined as recoverable in the temporary storage table (TST), CICS provides message
recovery for logical messages if the task has reached a syncpoint.
- PRINT
- specifies
that a print operation is to be started at a 3270 printer or at a 3275 with
the printer adapter feature, or that data on an LUTYPE2 (3274/76 or 3790)
is to be printed on a printer allocated by the controller. If this option
is omitted, the data is sent to the printer buffer but is not printed.
- REQID(name)
- specifies
a 2-character prefix to be used as part of a temporary storage identifier
for CICS message recovery. Only one prefix can be specified for each logical
message. The default prefix is **.
BMS message recovery is provided for
a logical message only if the PAGING option is specified in the BMS SEND commands,
and if the syncpoint has been reached.
- SET(ptr-ref)
- specifies
the pointer to be set to the address of the output data.
The SET option
specifies that completed pages are to be returned to the application program.
The pointer is set to the address of a list of completed pages. See the description
of the SET option in the section about full-function BMS in the CICS Application Programming Guide for
more guidance on using the SET option.
If TIOAPFX=YES is specified
in the map definition, the pointer returned contains the address of the TIOA
prefix. The user data starts at offset X'0C' from the start of the
TIOA prefix.
- TERMINAL
- specifies
that the output data is to be sent to the terminal that originated the transaction.
- WAIT
- specifies
that control should not be returned to the application program until the output
operation has been completed.
If WAIT is not specified, control returns
to the application program when the output operation has started. A subsequent
input or output command (terminal control, BMS, or batch data interchange)
causes the application program to wait until the previous command has been
completed.
Conditions
- IGREQCD
- occurs
when an attempt is made to execute a SEND CONTROL command after a SIGNAL data-flow
control command with a request change direction (RCD) code has been received
from an LUTYPE4 logical unit.
Default action: terminate the task abnormally.
- IGREQID
- occurs
if the prefix specified in the REQID option is different from that established
by a previous REQID option, or by default for this logical message—REQID (**).
Default action: terminate the task abnormally.
- INVLDC
- occurs
if the specified LDC mnemonic is not included in the LDC list for the logical
unit.
Default action: terminate the task abnormally.
- INVPARTN
- occurs
if the specified partition is not defined in the partition set associated
with the application program.
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).
also occurs (RESP2 not set) in the following situation:
- Control information is output to the same partition or LDC as mapped data
while a BMS logical message is active. If neither partitions nor LDCs are
in use, control information is output to the same device as mapped data.
Default action: terminate the task abnormally.
- RETPAGE
- occurs
if the SET option is specified and a completed page is ready for return to
the application program.
Default action: return control to the application
program at the point immediately following the BMS SEND command.
- TSIOERR
- occurs
if there is an irrecoverable temporary storage input/output error.
Default
action: terminate the task abnormally.
- WRBRK
- occurs
if the command is interrupted by the terminal operator pressing the ATTN key.
It applies only to the 2741 Communication Terminal, and only if write break
is supported for CICS.
Default action: ignore the condition.