Outbound BRIH message header
| Offset
Hex |
Type
|
Len
|
Name
|
|---|---|---|---|
| (0)
|
STRUCTURE
|
180
|
BRIH
|
| (0)
|
CHARACTER
|
4
|
BRIH-STRUCID
|
| (4)
|
FULLWORD
|
4
|
BRIH-VERSION
|
| (8)
|
FULLWORD
|
4
|
BRIH-STRUCLENGTH
|
| (C)
|
n/a
|
20
|
reserved
|
| (20)
|
BINARY
|
4
|
BRIH-RETURNCODE
|
| (24)
|
BINARY
|
4
|
BRIH-COMPCODE
|
| (28)
|
BINARY
|
4
|
BRIH-REASON
|
| (2C)
|
n/a
|
8
|
reserved
|
| (34)
|
BINARY
|
4
|
BRIH-REMAININGDATALENGTH
|
| (38)
|
FULLWORD
|
4
|
BRIH-DATALENGTH
|
| (3C)
|
n/a
|
12
|
reserved
|
| (48)
|
FULLWORD
|
4
|
BRIH-TASKENDSTATUS
|
| (4C)
|
CHARACTER
|
8
|
BRIH-FACILITY
|
| (54)
|
CHARACTER
|
4
|
BRIH-FUNCTION
|
| (58)
|
CHARACTER
|
4
|
BRIH-ABENDCODE
|
| (5C)
|
CHARACTER
|
4
|
BRIH-SYSID¹
|
| (60)
|
n/a
|
28
|
reserved
|
| (7C)
|
CHARACTER
|
4
|
BRIH-TRANSACTIONID
|
| (80)
|
n/a
|
16
|
reserved
|
| (90)
|
CHARACTER
|
4
|
BRIH-NEXTTRANSACTIONID
|
| (94)
|
CHARACTER
|
8
|
BRIH-NETNAME
|
| (9C)
|
CHARACTER
|
4
|
BRIH-TERMINAL
|
| (A0)
|
FULLWORD
|
8
|
BRIH-NEXTTRANIDSOURCE
|
| (A8)
|
FULLWORD
|
4
|
BRIH-ERROROFFSET
|
| (AC)
|
FULLWORD
|
4
|
BRIH-SEQNO
|
| (B0)
|
n/a
|
4
|
reserved
|
Note:
- BRIH-SYSID is available only for the Link3270 bridge with extended support.
The following fields are returned in an output message. Other fields are not relevant.
- BRIH-RETURNCODE
- Return code from the Link3270 interface. See BRIH-RETURNCODE values for a list of possible return codes, and their associated BRIH-COMPCODE and BRIH-REASON values.
- BRIH-COMPCODE
- Additional error information. See BRIH-RETURNCODE values for a list of possible return codes, and their associated BRIH-COMPCODE and BRIH-REASON values.
- BRIH-REASON
- Additional error information. See BRIH-RETURNCODE values for a list of possible return codes, and their associated BRIH-COMPCODE and BRIH-REASON values.
- BRIH-REMAININGDATALENGTH
- (Session mode)
The length of the remaining message if the COMMAREA is too small to return the complete outbound message. The remaining message is prefixed by another BRIH (included in the length). If there is no more data , this field is set to zero. See Delivering large messages for information about processing large messages.
- BRIH-DATALENGTH
- The length of the output message, including the BRIH.
- BRIH-TASKENDSTATUS
- The status of the user transaction. Possible values are:
- BRIHTES-CONVERSATION
- The user transaction has issued an input command for which no vector has been supplied, and BRIH-CONVERSATIONALTASK was specified in the inbound BRIH header.
- BRIHTES-ENDTASK
- The user transaction has ended (or abended).
- BRIH-FACILITY
- This value identifies the session. It is set on return from an allocate request and must be supplied on every subsequent request in the session. On return from a delete-facility request or a run request in single-transaction mode, it is reset to BRIHFACT-NEW.
- BRIH-FUNCTION
- Additional error information returned for some return codes. See BRIH-RETURNCODE values for details.
- BRIH-ABENDCODE
- The abend code returned if the transaction abends. If the transaction
completed successfully, this is set to BRIHAC-NONE.
Transaction abends are indicated by the return code BRIHAC-APPLICATION-ABEND. See BRIH-RETURNCODE values for details.
- BRIH-SYSID
- The region in which the transaction ran. This is the system ID of the AOR as it is known by the routing region. If the transaction ran in the routing region, this field is set to blanks. This field is available only 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.
- BRIH-TRANSACTIONID
- BRIH-TRANSACTIONID is both an input and an output field. Normally
the output value is the same as the input value. The exceptions to
this are:
- When the request is for message recovery and the input BRIH-TRANSACTIONID is set to BRIHT-RESEND-MESSAGE. See Recovery from connection failure for further information.
- When the router region resource definition of the transaction is an alias of the definition in the AOR, the transaction id in the AOR is returned.
- BRIH-NEXTTRANSACTIONID
- The name of the next transaction returned by the user transaction (usually by EXEC CICS® RETURN TRANSID). If there is no next transaction, this field is set to blanks.
- BRIH-NETNAME
- (Allocation only)
The NETNAME assigned to the bridge facility.
- BRIH-TERMINAL
- (Allocation only)
The TERMID assigned to the bridge facility.
- BRIH-NEXTTRANIDSOURCE
- The source of the next transaction id. Possible values are:
- BRIHNTS-NORMAL
- Created by the TRANSID option of an EXEC CICS RETURN command, or by SET TERMINAL NEXTTRANSID.
- BRIHNTS-IMMEDIATE
- Created by the TRANSID option of an EXEC CICS RETURN IMMEDIATE command.
- BRIHNTS-STARTED
- Created by the TRANSID option of an EXEC CICS START command.
- BRIH-ERROROFFSET
- The offset from the start of the message to the location of the invalid data for message validation errors.
- BRIH-SEQNO
- (Session mode only) A sequence number returned on every message. The sequence number is set to 0 on an allocate facility request and incremented on subsequent requests. The exceptions to this are:
- A successful BRIHT-RESEND-MESSAGE request returns the previous message and its sequence number.
- If BRIHRC-INVALID-FACILITY-TOKEN is returned, the sequence number is undefined.