RETURN copies a member of a source library to an output library if the base specified for the target version has been reserved by the user in the output library. It deletes the member from the source library and cancels the reservations in the output library.
There is no base for the first version of a member. In this case administration authorization is required to call RETURN.
ED1 specifies the source member, LD1 the source library, ED2 the target member and LD2 the target library. LD1 and LD2 may designate the same library. The complete type, name and version of the member must be specified.
ED3 designates the base for member ED2. The following must apply:
ED2.TYP=ED3.TYP, ED2.NAME=ED3.NAME
If there is no version specified in ED3.VERSION (=blank), the version borrowed by the user is taken to be the base version (an error is reported in the event of ambiguity).
There are four possible subcode specifications: UNUSE, INCP, HIGP and INCB
Subcode specifications other than UNUSE result in special treatment of the version specification (see "ED (Element Description)"). The version specification in ED3 is ignored.
Moreover, the user can enter a date or time of day in the fields USER-DATE and USER-TIME of ED2. These fields must contain blanks if the date and time are to be copied from the input member.
The parameters OVERWRITE and DESTROY are interpreted.
OVERWRITE=EXTEND and OVERWRITE=NAME are not allowed.
The storage mode of the target member (ED2) is governed by the base (ED3).
Call parameters
The parameter structures must be given in the following sequence in the subroutine call.
Parameter | Field | Meaning |
CB | SCBVERSION FUNCTION SUBCODE ACC DESTROY OVERWRITE LD-RETURN | Function control block Interface version Function code X'1E' Version automation Subroutine access identification Physical overwriting Logical overwriting Full DMS file name in LD |
LD1 | PASSWORD LINK MAX-NAME-LEN NAME | Source library descriptor Password as per PASSWORD command Link name Maximum length of library name Library name |
ED1 | TYP NAME VERSION | Source member descriptor Member type Member name Member version |
LD2 | PASSWORD LINK MAX-NAME-LEN NAME | Target library descriptor Password as per PASSWORD command Link name Maximum length of library name Library name |
ED2 | TYP NAME VERSION STORE-FORM USER-DATE USER-TIME | Target member descriptor Member type Member name Member version Storage mode Date specified by user Time of day specified by user |
ED3 | TYP NAME VERSION | Base member descriptor Member type = ED2.TYP Member name = ED2.NAME Member version (base version) |
Return parameters
Parameter | Field | Meaning |
CB | RETURNCODE LMS-MSG DMS-MSG PLAM-MSG | Function control block Return code LMS message code DMS message code PLAM message code |
LD1 | NAME | Source library descriptor Full DMS file name of library (dependent on LD-RETURN field of CB) |
ED1 | VERSION | Source member descriptor Member version (if call used *HIGH) |
LD2 | NAME | Target library descriptor Full DMS file name of library (dependent on LD-RETURN field of CB) |
ED2 | VERSION | Target member descriptor Member version (with version automation and *HIGH) |