RETURN-ELEMENT kopiert Elemente einer Quellbibliothek in eine Ausgabebibliothek, sofern die zur Zielversion angegebene Basis in der Ausgabebibliothek vom Benutzer reserviert ist, löscht die Elemente in der Quellbibliothek und gibt die Reservierungen in der Ausgabebibliothek wieder zurück.
Zur ersten Version eines Elementes gibt es noch keine Basis. RETURN-ELEMENT erfordert in diesem Falle Administrationsrecht.
Der Basistyp für Quell- und Zielelement darf unterschiedlich sein, wenn Textelemente zurückgegeben werden.
Dem zu schreibenden Element wird von der Zugriffsmethode ein Kommentarsatz (Satzart 2) zugefügt, der HOLDER, DATE und TIME des Vorganges protokolliert. Der Satz wird als erster Satz der Satzart geschrieben. Dahinter wird der bei COMMENT angegebene Text als Kommentarsatz geschrieben. Bereits vorhandene Kommentarsätze werden dahinter kopiert. Wird das Element überdies zur Basis einer anderen Version geschrieben (also nicht erste Version unter einem Namen), so werden alle Rechte von der Basisversion auf die neue Version übernommen. STATE wird bei beiden Versionen auf FREE gesetzt. Die CCSN wird vom Quellelement übernommen. USER-DATE wird neu bestimmt.
RETURN-ELEMENT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ELEMENT = *LIBRARY-ELEMENT (...)
Angaben für die gewünschte Elementbezeichnung.
LIBRARY = *STD / <filename 1..54 without-vers> / *LINK(...)
Angabe der Bibliothek, in der sich die betroffenen Elemente befinden.
LIBRARY = *STD
Die durch OPEN-LIBRARY eröffnete Bibliothek.
LIBRARY = <filename 1..54 without-vers>
Name der Bibliothek.
LIBRARY = *LINK(...)
Die über den Dateikettungsnamen zugewiesene Bibliothek.
LINK-NAME = <structured-name 1..8>
Dateikettungsname der Bibliothek.
ELEMENT = *ALL / <composed-name 1..64 with-under with-wild(132)>(...)
Namen der Elemente, die zurückgegeben werden sollen.
VERSION = *HIGHEST-EXISTING / *UPPER-LIMIT /
<composed-name 1..24 with-under>
Version der zurückzugebenden Elemente.
VERSION = *HIGHEST-EXISTING
Das Element mit der höchsten bestehenden Version bzgl. BASE wird zurückgegeben.
VERSION = *UPPER-LIMIT
Die in der Bibliothek unter dem angegebenen TYPE und Namen höchstmögliche Version X’FF’ wird zurückgegeben.
VERSION = <composed-name 1..24 with-under>
Der hier angegebene Text wird als Versionsbezeichnung interpretiert.
BASE = *STD / <composed-name 1..24 with-under with-wild>
Präfix für die Versionsauswahl. Im Zusammenhang mit VERSION=*HIGHEST-EXISTING kann damit die höchste Version mit einem bestimmten Präfix angesprochen werden. BASE=*STD wirkt wie BASE=*.
TYPE = *LMS-DEFAULT / *ALL / <alphanum-name 1..8 with-wild(20)>
Typ der zurückzugebenden Elemente.
USER-DATE = *ANY / *TODAY / <date 8..10 with-compl> / *INTERVAL(...)
Datum, das vom Benutzer vergeben wurde.
USER-DATE = *ANY
Es werden Elemente unabhängig von diesem Datum bereitgestellt.
USER-DATE = *TODAY
Nur Elemente mit dem aktuellen Tagesdatum werden zurückgegeben.
USER-DATE = <date 8..10 with-compl>
Nur Elemente mit dem angegebenen Datum werden zurückgegeben.
USER-DATE = *INTERVAL(...)
Nur Elemente mit einem in dem angegebenen Zeitraum liegenden Datum werden zurückgegeben.
FROM = 1900-01-01 / <date 8..10 with-compl>
Beginn des Zeitraums.
TO = *TODAY / <date 8..10 with-compl>
Ende des Zeitraums.
CREATION-DATE = *ANY / *TODAY / <date 8..10 with-compl> / *INTERVAL(...)
Erzeugungsdatum des Elementes. Beschreibung der Operanden siehe Operand USER-DATE dieser Anweisung.
MODIFICATION-DATE = *ANY / *TODAY / <date 8..10 with-compl> / *INTERVAL(...)
Datum der letzten Änderung für das Element. Beschreibung der Operanden siehe Operand USER-DATE dieser Anweisung.
EXCEPT-ELEMENT = *NONE / *ELEMENT(...)
Angabe der Elemente, die von der oben getroffenen Auswahl ausgeschlossen werden.
EXCEPT-ELEMENT = *NONE
Es wird kein Element ausgeschlossen.
EXCEPT-ELEMENT = *ELEMENT(...)
Angabe der Elemente, die ausgeschlossen werden sollen. Ein Element wird ausgeschlossen, wenn alle Felder der EXCEPT-ELEMENT-Struktur, die nicht auf *ANY gesetzt sind, das Element als Treffer ausweisen. Sind alle Felder der EXCEPT-ELEMENT-Struktur auf *ANY gesetzt, so werden alle Elemente ausgeschlossen.
Zur Beschreibung der Operanden siehe Operand *LIBRARY-ELEMENT dieser Anweisung.
TO-ELEMENT = *LIBRARY-ELEMENT(...)
Angabe, wohin und unter welchem Namen das Element kopiert werden soll.
LIBRARY = <filename 1..54 without-vers> / *LINK(...)
Angabe der Bibliothek, in die das Element kopiert werden soll.
LIBRARY = <filename 1..54 without-vers>
Name der Bibliothek, in die das Element zurückgegeben werden soll. Existiert die Bibliothek noch nicht, wird sie neu eingerichtet.
LIBRARY = *LINK(...)
Die über den Dateikettungsnamen zugewiesene Bibliothek.
LINK-NAME = <structured-name 1..8>
Dateikettungsname der Bibliothek.
ELEMENT = *BY-SOURCE(...) /
<composed-name 1..132 with-under with-wild-constr>(...)
Name, den das Zielelement erhalten soll.
ELEMENT = *BY-SOURCE(...)
Das Zielelement erhält den Namen des Quellelementes.
VERSION = *INCREMENT / *LMS-DEFAULT / *BY-SOURCE /
*HIGHEST-EXISTING / *UPPER-LIMIT / <composed-name 1..24 with-under>
Version, die das Zielelement erhalten soll.
VERSION = *INCREMENT
Abhängig von der unter dem Typ geltenden Konvention wird unter existierenden Elementen gleichen Typs und Namens eine neue, höhere Version ansonsten eine Defaultversion erzeugt.
VERSION = *BY-SOURCE
Das Zielelement erhält die gleiche Version wie das Quellelement.
VERSION = *HIGHEST-EXISTING
Abhängig von der unter dem Typ geltenden Konvention wird unter existierenden Elementen gleichen Typs und Namens die höchste zu BASE passende Version überschrieben, ansonsten wird eine Defaultversion erzeugt.
VERSION = *UPPER-LIMIT
Die höchstmögliche Version X’FF’ wird erzeugt.
VERSION = <composed-name 1..24 with-under>
Das Zielelement erhält die hier angegebene Version.
BASE = *STD / <composed-name 1..24 with-under with-wild>
Legt die Basis für das Zielelement fest. Bei BASE=*STD ist die vom Benutzer ausgeliehene Version Basisversion (Fehler bei Mehrdeutigkeit).
ELEMENT = <composed-name 1..132 with-under with-wild-constr>(...)
Name, den das Zielelement erhalten soll. Er kann auch mit Wildcards eingegeben werden.
VERSION =*INCREMENT / *LMS-DEFAULT / *BY-SOURCE /
*HIGHEST-EXISTING / *UPPER-LIMIT / <composed-name 1..24 with-under>
Version, die das Zielelement erhalten soll. Beschreibung der Operanden siehe oben.
BASE = *STD / <composed-name 1..24 with-under with-wild>
Legt die Basis für das Zielelement fest.
TYPE = *BY-SOURCE / *LMS-DEFAULT /<alphanum-name 1..20 with-wildcard-constr>
Typ, den das Zielelement erhalten soll.
TYPE = *BY-SOURCE
Das Zielelement erhält die gleiche Typbezeichnung wie das Quellelement.
USER-DATE = *BY-SOURCE / *TODAY / <date 8..10 with-compl>
Datum, das vom Benutzer vergeben wird.
USER-DATE = *BY-SOURCE
Das neue Element erhält das gleiche Datum wie das ursprüngliche Element.
USER-DATE = *TODAY
Das aktuelle Tagesdatum wird vergeben.
USER-DATE = <date 8..10 with-compl>
Das Datum muss in der Form [JJ]JJ-MM-TT eingegeben werden.
STORAGE-FORM = *LMS-DEFAULT / *STD /*FULL / *DELTA
Speicherform für das anzulegende Element. Die Speicherform darf den Einstellungen durch MODIFY-TYPE-ATTRIBUTES bzw. MODIFY-LIBRARY-ATTRIBUTES nicht widersprechen und alle Elemente eines Typs und Namens müssen die gleiche Speicherform haben.
STORAGE-FORM = *STD
Das Element wird gemäß der für den Elementscope geforderten Speicherform angelegt. Widersprüchliche Anforderungen führen auf Fehler. Ist nichts besonderes gefordert, wird Vollspeicherung gewählt.
STORAGE-FORM = *FULL
Das Element wird vollgespeichert angelegt (Fehler falls nicht zulässig).
STORAGE-FORM = *DELTA
Das Element wird deltagespeichert angelegt (Fehler falls nicht zulässig). Die Angabe ist zulässig für die Elementtypen S, P, D, J, M, X bzw. davon abgeleitete Elementtypen.
COMMENT = *BY-SOURCE / <c-string1..72 with-low>
Steuert die Angabe eines Kommentartextes.
COMMENT = *BY-SOURCE
Der Kommentartext wird dem Quellelement entnommen.
COMMENT = <c-string 1..72 with-low>
Kommentartext, der in das Zielelement eingefügt wird. Der Kommentartext der Quelle bleibt zusätzlich erhalten.
WRITE-MODE = *LMS-DEFAULT / *CREATE / *REPLACE / *ANY
Steuerung des Überschreibverhaltens.
WRITE-MODE = *CREATE
Das Zielelement darf noch nicht existieren; es wird neu erzeugt.
WRITE-MODE = *REPLACE
Das Zielelement muss bereits existieren und wird dann ersetzt.
WRITE-MODE = *ANY
Existiert das Zielelement, wird es ersetzt, ansonsten wird das Zielelement neu erzeugt.
DIALOG-CONTROL = *LMS-DEFAULT / *NO / *YES / *ERROR
Dieser Operand legt fest, ob während der Ausführung einer Anweisung ein Dialog mit dem Benutzer geführt werden soll oder nicht.
Nähere Erläuterungen zur Dialogführung unter MODIFY-LMS-DEFAULTS.
Anweisungs-Returncode
(SC2) | SC1 | Maincode | Bedeutung |
0 | CMD0001 | Ohne Fehler | |
2 | 0 | LMS0129 | Anweisung abgebrochen durch Benutzer |
1 | CMD0230 | Syntaxfehler | |
32 | LMS1002 | Interner Fehler | |
64 | LMS0020 | Ziel-Element oder Ziel-Datei nicht vorhanden | |
64 | LMS0213 | Name existiert als Delta-Element | |
64 | LMS0214 | Name existiert als Voll-Element | |
64 | LMS0302 | Element nicht gefunden | |
64 | LMS0509 | Ziel-Element oder Ziel-Datei schon vorhanden | |
64 | LMS0510 | Basis nicht gefunden | |
64 | LMS1003 | Fehler während Mengenverarbeitung (Wildcard) bei mindestens einem Element oder einer Datei | |
64 | LMS1004 | Sonstige Fehler | |
64 | PLA0223 | Nur Blätter eines Delta-Baumes überschreibbar | |
64 | PLA0224 | Speicherform nicht erlaubt | |
64 | PLA0229 | Kein Zugriffsrecht für das Element | |
64 | PLA0233 | Ausleihstatus verhindert Elementzugriff | |
64 | PLA0475 | Funktion verletzt Versionsautomatismus | |
64 | PLA0476 | Version passt nicht zur geltenden Konvention | |
64 | PLA0478 | Versionsüberlauf bei Erhöhung | |
130 | LMS0041 | Systemadressraum erschöpft | |
130 | LMS0411 | Bibliothek gesperrt | |
130 | LMS0412 | Element gesperrt | |
130 | LMS0413 | Typ gesperrt |
Notwendige Zugriffsrechte
Bei ELEMENT: | Leserecht für LIBRARY und ELEMENT |
Bei TO-ELEMENT: | Lese- und Schreibrecht für LIBRARY |
Administrationsrecht, sofern die angegebene Elementbezeichnung neu ist. Ansonsten nur Schreibrecht für das unter der angegebenen Elementbezeichnung existierende Element (kein Administrationsrecht mehr erforderlich).
Bei Deltaspeicherung muss für das durch BASE bestimmte Element Leserecht gegeben sein.
Bei aktivem WRITE-CONTROL muss die USERID des Benutzers bei dem durch BASE bestimmten Element als HOLDER eingetragen sein, sofern eine Basisversion existiert. Es kann nur eine neue Version erzeugt oder diese Basisversion überschrieben werden, sofern Schreibrecht gegeben ist. Administrationsrecht ist in diesem Falle nicht mehr erforderlich.
Hinweis
Beim Anlegen eines Elements ist die unter dem Typ geltende Konvention zu beachten. Insbesondere dann, wenn der Zieltyp die Konvention STD-TREE hat, können Probleme auftreten, wenn auf der Quellseite Nebenzweigversionen existieren, deren zugehörige Hauptzweigversion gelöscht ist. In diesem Fall können die betreffenden Nebenzweige nicht kopiert werden; es erfolgt eine Fehlermeldung von LMS.