Link3270 SEND TEXT vector
This vector is the data supplied by an EXEC CICS SEND TEXT command.
See SEND TEXT for details of the command options.
| Offset |
Type |
Len |
Name |
|---|---|---|---|
| (0) |
STRUCTURE |
60 |
BRIV-SEND-TEXT |
| (0) |
STRUCTURE |
16 |
Output header |
| (10) |
CHARACTER |
4 |
BRIV-ST-ERASE-INDICATOR |
| (14) |
CHARACTER |
4 |
FILLER |
| (18) |
CHARACTER |
4 |
BRIV-ST-FREEKB-INDICATOR |
| (1C) |
CHARACTER |
4 |
BRIV-ST-ALARM-INDICATOR |
| (20) |
CHARACTER |
4 |
BRIV-ST-ACCUM-INDICATOR¹ |
| (24) |
CHARACTER |
4 |
BRIV-ST-LAST-INDICATOR |
| (28) |
CHARACTER |
4 |
BRIV-ST-WAIT-INDICATOR |
| (2C) |
FULLWORD |
4 |
BRIV-ST-CURSOR |
| (30) |
CHARACTER |
4 |
BRIV-ST-MSR-DATA |
| (34) |
CHARACTER |
4 |
BRIV-ST-TEXT-TYPE |
| (38) |
FULLWORD |
4 |
BRIV-ST-DATA-LEN |
| (3C) |
FULLWORD |
4 |
BRIV-ST-DATA-OFFSET¹ |
| (40) |
FULLWORD |
4 |
BRIV-ST-HEADER-LEN¹ |
| (44) |
FULLWORD |
4 |
BRIV-ST-HEADER-OFFSET¹ |
| (48) |
FULLWORD |
4 |
BRIV-ST-TRAILER-LEN¹ |
| (4C) |
FULLWORD |
4 |
BRIV-ST-TRAILER-OFFSET¹ |
| 50 |
CHARACTER |
BRIV-ST-DATA² |
Note:
- The fields in bold type are available only for the Link3270 bridge with extended support.
- BRIV-ST-DATA is deprecated. The recommended method for addressing this field is by using BRIV-ST-DATA-OFFSET.
- BRIV-ST-ERASE-INDICATOR
- The type of ERASE specified by the CICS® SEND
TEXT command. Valid values are:
- BRIVSTEI-NOERASE
- No ERASE.
- BRIVSTEI-ERASE
- ERASE.
- BRIVSTEI-ERASEALTERNATE
- ERASE ALTERNATE.
- BRIVSTEI-DEFAULT
- ERASE DEFAULT.
- BRIV-ST-FREEKB-INDICATOR
- The presence of FREEKB on the SEND TEXT command. Valid values
are:
- BRIVSTFKI-YES
- FREEKB specified.
- BRIVSTFKI-NO
- FREEKB not specified.
- BRIV-ST-ALARM-INDICATOR
- The presence of ALARM on the SEND TEXT command. Valid values are:
- BRIVSTAI-YES
- ALARM specified.
- BRIVSTAI-NO
- ALARM not specified.
- BRIV-ST-ACCUM-INDICATOR
- Indicates whether or not the ACCUM option is specified for EXEC CICS SEND TEXT, EXEC CICS SEND MAP, or
EXEC CICS SEND CONTROL. This parameter is only available for the Link3270 bridge with extended
support. See Link3270 bridge basic and extended support for a description of
the different levels of support for the Link3270 bridge. Values are:
- Y
- The ACCUM option is specified.
- N
- The ACCUM option is not specified.
- BRIV-ST-LAST-INDICATOR
- The presence of LAST on the SEND TEXT command. Valid values are:
- BRIVSTLI-YES
- LAST specified.
- BRIVSTLI-NO
- LAST not specified.
- BRIV-ST-WAIT-INDICATOR
- The presence of WAIT on the SEND TEXT command. Valid values are:
- BRIVSTWI-YES
- WAIT specified.
- BRIVSTWI-NO
- WAIT not specified.
- BRIV-ST-CURSOR
- The presence of CURSOR(data-value) on
the SEND TEXT command. Valid values are:
- BRIVSTCRS-DYNAMIC
- CURSOR specified (dynamic cursor positioning).
- BRIVSTCRS-NONE
- CURSOR(data-value) not specified.
- nn
- The value of CURSOR(data-value) specified.
- BRIV-ST-MSR-DATA
- The value of the MSR option specified on the SEND TEXT command.
Valid values are:
- BRIVSTMSR-NONE
- MSR option not specified.
- other
- The value of the MSR option specified.
- BRIV-ST-TEXT-TYPE
- The presence of MAPPED or NOEDIT options on the SEND TEXT command.
Valid values are:
- BRIVSTTT-MAPPED
- MAPPED specified.
- BRIVSTTT-NOEDIT
- NOEDIT specified.
- BRIVSTTT-DEFAULT
- Neither MAPPED nor NOEDIT specified.
- BRIV-ST-DATA-LEN
- The length of the data in BRIV-ST-DATA¹.
- BRIV-ST-DATA-OFFSET
- The offset of the data from the start of the vector. This parameter is only available for the Link3270 bridge with extended support. See Link3270 bridge basic and extended support for a description of the different levels of support for the Link3270 bridge.
- BRIV-ST-HEADER-LEN
- The length of the text header. This parameter is only available for the Link3270 bridge with extended support. See Link3270 bridge basic and extended support for a description of the different levels of support for the Link3270 bridge.
- BRIV-ST-HEADER-OFFSET
- The offset of the text header from the start of the vector. Use this value to address the header. This parameter is only available for the Link3270 bridge with extended support. See Link3270 bridge basic and extended support for a description of the different levels of support for the Link3270 bridge.
- BRIV-ST-TRAILER-LEN
- The length of the text trailer. This parameter is only available for the Link3270 bridge with extended support. See Link3270 bridge basic and extended support for a description of the different levels of support for the Link3270 bridge.
- BRIV-ST-TRAILER-OFFSET
- The offset of the text trailer from the start of the vector. Use this value to address the trailer. This parameter is only available for the Link3270 bridge with extended support. See Link3270 bridge basic and extended support for a description of the different levels of support for the Link3270 bridge.
- BRIV-ST-DATA
- This field is included only for compatibility with the basic support version of the Link3270 bridge. Use BRIV-ST-DATA-OFFSET to access the data contained in the FROM option of the SEND TEXT command.
Note:
- If the MAPPED option is used, you must add a 4 byte page control area (PGA) to the end of the data. See SEND TEXT MAPPED for a description of the PGA. These 4 bytes are not included in BRIV-ST-DATA-LEN, but are included in BRIV-OUTPUT-VECTOR-LENGTH and BRIH-DATALENGTH.