Subparameters for REQUEST=XCOUPLE

REQUEST=XCOUPLE
Use to manage connections between a local XRC session and a master XRC session.
,SID=sid
A required input parameter field containing the XRC local session ID for the request. The ID is left-justified and padded on the right with blanks.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,ETYPE=etype
A required output parameter field that specifies the type of coupling operation to be processed. The value is left justified and padded on the right with blanks. The following four options are available for use:
  • ADD — says to add the logical session to the master session.
  • DELETE — says to delete the logical session from the master session.
  • PURGE — says to purge (cleanup) the logical session from the master data set.
  • RELEASE — says to release a HOLD on the master session.

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,RETINFO=retinfo
A required output parameter field that is used to return detailed information about the results of executing the request. Information about the results of scheduling the request are returned in the RETCODE and RSNCODE fields. Align the area on a word boundary. The first 4-bytes contain the return code and the second 4-bytes contain the reason code. The remainder of the information is dependent on the return and reason codes. See the coding example SDM API usability guide about how to coordinate the RETCODE, RSNCODE, and RETINFO fields.

To code: Specify the RS-type address, or address in register (2)-(12), of a 100-character field.

,MESSAGES=messages
A required output parameter field in which ANTRQST will place the address of a buffer containing messages about the results of executing the request. These are the messages that would have been returned to the caller if the TSO interface had been used. If there are no messages, the address will be zero.
An ANTRQST message buffer has the following format:
  • Bytes 1-4 contain the size of the ANTRQST message buffer.
  • Byte 5 contains the subpool of the ANTRQST message buffer.
  • Byte 6 is not used.
  • Bytes 7-8 contain the number of messages in the array that follows.

The rest of the message buffer is an array of messages. Each message has the following format:

  • Bytes 1-2 contain the size of the message in bytes 3-x.
  • Bytes 3-x contain the message.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 4-character field.

,ECB=ecb
,ECB=NO_ECB
An optional input parameter field that SDM posts for an asynchronous request. This field is ignored for synchronous requests.

The default is NO_ECB.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,HLQ=hlq
,HLQ=SYS1
An optional input parameter field containing the high level qualifier of the XRC journal data set. The name is left justified and padded on the right with blanks. If the field contains binary zeros, the default is used.

The default is SYS1.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MHLQ=mhlq
,MHLQ=SYS1
An optional input parameter field containing the high level qualifier of the Master Control data set. The name is left justified and padded on the right with blanks. If the field contains binary zeros, the default is used.

The default is SYS1.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MID=mid
,MID=NO_MID
An optional input parameter field containing the XRC master session ID for the request. The ID is left justified and padded on the right with blanks. If the field contains binary zeros, the default is used.

The default is NO_MID.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,WAITTIME=waittime
,WAITTIME=0
An optional input parameter field containing how long in seconds SDM will wait for a request to complete. A value of zero says to not time the request. If the time expires before the request is complete a value of 7039 (RQST_WAITTIME_EXPIRED [see ANTRQSTL]) will be returned. If the request is a synchronous request the value will be placed in the return code part of the RETINFO field. If the request is an asynchronous request, the value will be used as the ECB post code. The default is 0.

To code: Specify the RS-type address, or address in register (2)-(12), of a halfword field.