TOCSEC liefert Informationen über die Elementeinträge in der über LD vereinbarten Bibliothek. Dazu wird im sekundären Inhaltverzeichnis alphabetisch nach den Elementeinträgen (TYP SEC-NAME SEC-ATTRIBUTE NAME VERSION) gesucht.
Bei jedem Aufruf von TOCSEC muss eine zulässige TOC-Identifikation angegeben werden, damit sich ein nachfolgendes TOC auf diese Funktion beziehen kann. Für die TOC-Identifikation dürfen die Werte 1,...,10 angegeben werden. Bei TOCSEC-Funktionen mit gleichen Werten für die TOC-Identifikation gilt die zuletzt gemachte TOCSEC-Funktion.
Für das erste Element, das den in EM angegebenen Kriterien entspricht, wird die Elementinformation in die Felder von EI geschrieben. Entspricht kein Element den angegebenen Kriterien, wird im Feld RETURNCODE des CB EOF eingetragen. Die Felder von EI bleiben unverändert.
Ein Element entspricht den Kriterien, wenn es zu der in EM angegebenen Maske passt, d.h. jedes Feld des Elementes muss zu dem entsprechenden Feld bzw. der Bereichsangabe für die Elementgröße zu den entsprechenden Feldern der Maske passen.
Auswertung der Stringfelder der Maske EM:
Jedes Stringfeld wird bis zum ersten Leerzeichen ausgewertet. Ein Stringfeld, das mit einem Leerzeichen beginnt, wird als leer angenommen. Ein Leerzeichen am Anfang der Maske bedeutet das gleiche wie die Angabe ‘*‘, das Elementfeld passt immer zu dem Maskenfeld.
Auswertung der Felder E-SIZE-MIN und E-SIZE-MAX:
Es passen alle Elemente mit einer Größe (in PAM-Seiten) für die gilt:
E-SIZE-MIN ≤ Größe ≤ E-SIZE-MAX. Durch die Angabe von X‘00000000‘ bei E-SIZE-MIN und X‘FFFFFFFF‘ bei E-SIZE-MAX können auch beliebige Werte zur Auswahl zugelassen werden.
Zusätzlich zu den Maskenfeldern der TOCPRIM-Funktion werden die Felder SEC-NAME und SEC-ATTRIBUTE des EM als Suchkriterium herangezogen. CSECT-Namen mit mehr als 32 Zeichen werden vor dem Mustervergleich auf 32 Zeichen abgeschnitten.
Im Feld VERSION des EM können zwei Schlüsselwörter eingegeben werden:
*HIGH
Es wird nur nach der höchsten existierenden Version gesucht.*LOW
Es wird nur nach der niedrigsten existierenden Version gesucht.
Die Eingaben müssen links im Feld VERSION des EM beginnen und durch ein Leerzeichen beendet werden.
Ein zusätzlich in diesem Feld angegebenes Zeichen entwertet die Schlüsselwörter. Soll nach einer Version gesucht werden, die mit HIGH endet, genügt die Angabe „**HIGH“.
Für die Ausgabe gibt es zwei Formate zur Auswahl:
SHORT
Die zurückgegebene Elementinformation beinhaltet nur die Elementbezeichnung (TYP, NAME, VERSION), den Sekundärnamen (SEC-NAME), das Sekundärattribut (SEC-ATTRIBUTE) und die Speicherungsform (STORE-FORM). In den übrigen Feldern befinden sich Leerzeichen.
Diese Ausgabeform eignet sich beim Programmieren von Schleifen im rufenden Programm und wenn bei EM nur Bedingungen für die Elementbezeichnung, den Sekundärnamen und das Sekundärattribut (SEC-ATTRIBUTE) angegeben wurden.LONG
Die Elementinformation wird mit den Erweiterungen 1, 2 und 3 ausgegeben. CSECT-Namen mit mehr als 32 Zeichen werden zur Ausgabe im Feld SEC-NAME auf 32 Zeichen abgeschnitten. Werden solche Namen vollständig benötigt, so müssen die Sekundärsätze des Elementes mit GET gelesen werden.
Aufrufparameter
Die Parameterstrukturen müssen beim UP-Aufruf in dieser Reihenfolge stehen.
Parameterstruktur | Feld | Bedeutung |
CB | SCBVERSION FUNCTION SUBCODE ACC LD-RETURN | Funktionskontrollblock Schnittstellenversion Funktionscode X'04' Subcode (SHORT oder LONG) UP-Zugriffsidentifikation vollständiger DMS-Dateiname in LD |
TID | - | TOC-Identifikation keine Versorgung notwendig |
EI | - | Elementinformation keine Versorgung notwendig |
LD | PASSWORD LINK MAX-NAME-LEN NAME | Bibliothek-Beschreibung Kennwort lt. PASSWORD-Kommando Dateikettungsname Maximale Länge des Bibliotheksnamen Bibliotheksname |
EM | TYP NAME VERSION STORE-FORM USER-DATE USER-TIME CREATION-DATE CREATION-TIME MODIFI-DATE MODIFI-TIME SEC-NAME SEC-ATTRIBUTE P-TIND-READ P-READ-OWN P-READ-GRP P-READ-OTH P-READ-PIND P-TIND-WRIT P-WRIT-OWN P-WRIT-GRP P-WRIT-OTH P-WRIT-PIND P-TIND-EXEC P-EXEC-OWN P-EXEC-GRP P-EXEC-OTH P-EXEC-PIND P-GUARD-READ P-GUARD-WRIT P-GUARD-EXEC CCS-NAME P-TIND-HOLD P-HOLD-OWN P-HOLD-GRP P-HOLD-OTH P-HOLD-PIND P-GUARD-HOLD HOLD-STATE HOLDER ACCESS-DATE ACCESS-TIME E-SIZE-MIN E-SIZE-MAX | Element-Maske (Such-Muster) Elementtyp Elementname Elementversion Speicherungsform vom Benutzer vergebenes Datum vom Benutzer vergebene Uhrzeit Datum der Erzeugung des Elementes Uhrzeit der Erzeugung des Elementes Datum der letzten Änderung Uhrzeit der letzten Änderung Referenzname Referenzattribut Anzeigefeld für Leserecht Anzeigefeld für Leserecht (Eigentümer) Anzeigefeld für Leserecht (Gruppe) Anzeigefeld für Leserecht (alle anderen) Anzeigefeld für Leserecht-Kennwort Anzeigefeld für Schreibrecht Anzeigefeld für Schreibrecht (Eigentümer) Anzeigefeld für Schreibrecht (Gruppe) Anzeigefeld für Schreibrecht (alle anderen) Anzeigefeld für Schreibrecht-Kennwort Anzeigefeld für Ausführungsrecht Anzeigefeld für Ausführungsrecht (Eigentümer) Anzeigefeld für Ausführungsrecht (Gruppe) Anzeigefeld für Ausführungsrecht (alle anderen) Anzeigefeld für Ausführungsrecht-Kennwort Leseguard Schreibguard Ausführungsguard Coded-Character-Set-Name Anzeigefeld für Ausleihrecht Anzeigefeld für Ausleihrecht (Eigentümer) Anzeigefeld für Ausleihrecht (Gruppe) Anzeigefeld für Ausleihrecht (alle anderen) Anzeigefeld für Ausleihrecht-Kennwort Ausleihguard Hold Flag: Elementzustand USERID des Holders Datum des letzten Zugriffs für das Element Uhrzeit des letzten Zugriffs für das Element Untergrenze der Elementgrößenauswahl Obergrenze der Elementgrößenauswahl |
Rückkehrparameter
Parameterstruktur | Feld | Bedeutung |
CB | RETURNCODE LMS-MSG DMS-MSG PLAM-MSG | Funktionskontrollblock Returncode LMS-Meldungsschlüssel DMS-Meldungsschlüssel PLAM-Meldungsschlüssel |
LD | NAME | Bibliothek-Beschreibung vollständiger DMS-Dateiname der Bibliothek (abhängig |
EI | TYP ... | Elementinformation Felder des EI (siehe "EI Element Information") gefüllt gemäß Subcode bei TOCPRIM bzw. TOCSEC |