gtps1m12System Macros

$RETRC - Retrieve or Modify a Control Record

Use this system macro to retrieve or modify control records that are associated with TPF transaction services processing. This macro is only used by the transaction manager (TM) and resource managers (RMs). Through the use of the $RETRC macro, the TM and RMs control the commit scope environment.

Format




TYPE
Defines the type of control record to be acted on. This parameter is required. The following control record types are valid:

TMCR
Requests a transaction manager control record (TMCR).

CCR
Requests a commit control record (CCR).

TMCR=Ry
A register (R1-R7) used to identify the current TMCR and to contain the address of the retrieved TMCR. This parameter is required when you code TYPE=TMCR or ECB=NO.

STEP
Specifies the direction to use when retrieving a TMCR. This parameter is required when you code TYPE=TMCR.

NEXT
Retrieve the next TMCR in the chain of TMCRs.

PREV
Retrieve the previous TMCR in the chain of TMCRs.

ECB
Defines the area to which the TMCR is anchored. This parameter is required.

YES
Specifies that the TMCR is anchored out of the ECB at the CE2TMCR field.

NO
Specifies that the ECB TMCR anchor is not to be used. Instead, the TMCR address is supplied in the register specified in the TMCR parameter.

CCR=Rz
A register (R1-R7) used to identify the current CCR and to contain the address of the retrieved CCR. This parameter is required when you code TYPE=CCR.

RMID=Rx|equate
A register (R0-R7) or equate used to define the RMID associated with the record request. This parameter is required when you code TYPE=CCR.

ACTION
Specifies a modification to the chaining of CCRs. This parameter is optional. When this parameter is not specified, the CCRs are retrieved.

POPCHAIN
The chain of CCRs is removed from the current resource manager control record (RMCR) and added to the CCR chain of the previous RMCR; that is, the chain is popped back to the previous level of nested RMCRs. POPCHAIN is only valid when you code TYPE=CCR.

Entry Requirements

Return Conditions

Programming Considerations

Examples

$RETRC TYPE=TMCR,STEP=PREV,TMCR=R1,ECB=YES
 
$RETRC TYPE=CCR,CCR=R1,RMID=R2,ECB=YES