Optional parameters

The following are the optional parameters of the ARCHRCAL macro:

ASYNC

specifies whether the special asynchronous recall processing is requested. The requesting application must be authorized by the authorized program facility (APF) to request the ASYNC option. If ASYNC=YES is specified, the WAIT parameter must also be specified as YES to allow the ECB to be posted back to the user when DFSMShsm completes the function. The default is NO. This parameter applies to both SMS-managed and non-SMS-managed data sets.

If YES is specified, storage for the generated MWE is obtained in the requester's private storage, and an event control block (ECB) address is returned in register 1 when control is returned to the requester. The application program is responsible for freeing this storage area; however, it must not be freed until the ECB is posted. The ARCFMWE macro must be used to free the storage area by supplying the ECB address. In cases where a zero value is returned for the ECB address, the request has failed and storage is not obtained for the MWE. Upon return from the ARCFMWE macro, the return code is in register 15 and a reason code is in register 0. If register 15 contains a return code of 400, 401, or 806, this error is reported from the completion of the ARCFMWE macro. All other return codes contained in register 15 are from the completion of the ARCHRCAL macro. The last reported, nonzero return code is placed in register 15. For example:

If the return code from ARCHRCAL is:	And the return code from ARCFMWE is:	Then the return code placed in register 15 is from:
Zero	Nonzero	ARCFMWE
Nonzero	Zero	ARCHRCAL
Nonzero	Nonzero	ARCFMWE

WAIT

specifies whether you want the application to wait until DFSMShsm has processed this request. If YES is specified, the application waits until DFSMShsm completes processing of the request. The default is NO. This parameter applies to both SMS-managed and non-SMS-managed data sets.

TOVOL

specifies the address of a field containing the volume serial number of the volume to which the data set is recalled. For volseraddr, substitute the address of the six-byte area that contains the specified volume serial number. The volume serial number must be left-justified and padded with blanks. SMS-managed data sets are recalled to the volume determined by SMS.

Note: When the TOVOL parameter is used, the UNIT parameter must also be used.

UNIT

specifies the address of a field containing the unit type of the volume to which the data set is to be recalled. For unitaddr, use the address of the four-byte field that contains the UCB device type. For example, X'3010200F' is the UCB unit type for a 3390 device. For a table presenting the supported unit type and UCBs, see Table 1. If the data set is SMS-managed, SMS determines the unit type.

Note: When the UNIT parameter is used, the TOVOL parameter must also be used.

SNAPDCB

specifies the address of an open DCB that can be used for SNAP macro processing. This feature is intended for problem determination. If you specify this parameter, review Usage notes. For dcbaddr, specify the address of an open DCB.

TEST

specifies whether to refrain from sending a request for service to DFSMShsm. If YES is specified the service request is not sent. If NO is specified, a service request is sent to DFSMShsm. In both cases the parameters specified to the macro are checked for correctness. A 4xx return code results for invalid parameters. The default is NO.

DAOPT

specifies the type of data set accessing required after the recall of a direct access data set. This, in turn, implies the allowable target volume DASD types. The recalled data set must be non-SMS-managed. For details on DAOPT see DAOPTION: Selecting target volume track length.

TCBTOKEN=CURRENT

specifies that the current TCB TOKEN will be used to validate the ECB on POST. If not specified, the JOBSTEP TCB TOKEN will be used.

Note: When the TCBTOKEN=CURRENT parameter is used, both the ASYNC=YES and WAIT=YES parameters must also be used.