Automation Engine Script-Leitfaden > Funktionelle Gliederung > Datensequenzen > PREP_PROCESS_DOCU

PREP_PROCESS_DOCU

Script-Funktion: Stellt den Inhalt einer Dokumentations-Registerkarte als interne Auflistung (Datensequenz) für die weitere Verarbeitung zur Verfügung.

Syntax

PREP_PROCESS_DOCU(Objektname, [Doku-Tab])

Syntax	Beschreibung/Format
Objektname	Name eines beliebigen Objektes, dessen Dokumentations-Registerkarte ausgelesen werden soll. Format: Script-Literal oder Script-Variable
Registerkarte Dokumentation	Name der Registerkarte Dokumentation. Format: Script-Literal oder Script-Variable Erfolgt keine Angabe, so wird nach einer Dokumentations-Registerkarte mit dem Namen "Docu" gesucht.

Syntax

Beschreibung/Format

Objektname

Name eines beliebigen Objektes, dessen Dokumentations-Registerkarte ausgelesen werden soll.

Format: Script-Literal oder Script-Variable

Registerkarte Dokumentation

Name der Registerkarte Dokumentation.
Format: Script-Literal oder Script-Variable

Erfolgt keine Angabe, so wird nach einer Dokumentations-Registerkarte mit dem Namen "Docu" gesucht.

Rückgabewerte
Referenz auf die Datensequenz, welche den Inhalt der gewünschten Dokumentation-Registerkarte enthält.

Anmerkungen

Das Sprachmittel liest den Inhalt einer bestimmten Dokumentations-Registerkarte eines Objektes aus (Dokumentations-Registerkarten stehen für alle Objekttypen zur Verfügung) und stellt diesen in Form einer Datensequenz für die weitere Verarbeitung bereit. Anzugeben ist der Name des Objektes und der Dokumentations-Registerkarte (wie in der Variable UC_OBJECT_DOCU definiert).

Dabei kann sowohl eine strukturierte als auch eine einfache Doku-Registerkarte angegeben werden (= enthält nur Text).
Bei einer strukturierten Doku-Registerkarte, werden alle Elemente, die im linken Bereich der Registerkarte definiert sind, zeilenweise in die Datensequenz abgespeichert. Wird eine einfache Doku-Registerkarte angegeben, so wird deren Inhalt (Text) zeilenweise in die Datensequenz umgeleitet.

Bei der Angabe des Namens der Dokumentations-Registerkarte spielt Groß- und Kleinschreibung keine Rolle. Beispiel: Wird nach "docu" gesucht, wird die Registerkarte "Docu" trotzdem gefunden.

Wird keine Dokumentations-Registerkarte mit dem angegebenen Namen gefunden, bricht die Script-Funktion nicht ab. Die Datensequenz ist in diesem Fall lediglich nicht befüllt. Zum Abbruch kommt es nur, wenn der Objektname ungültig ist.

Beispiele

In folgendem Beispiel wird die Dokumentations-Registerkarte "Docu" des Objektes SCRI.TEST ausgelesen und deren Inhalt im Aktivierungsreport ausgegeben.

:SET &HND# = PREP_PROCESS_DOCU(SCRI.TEST,Docu)
:PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE(&HND#)
: PRINT &LINE#
:ENDPROCESS

:CLOSE_PROCESS &HND#

Siehe auch:

Script-Sprachmittel	Beschreibung
:PROCESS... :TERM_PROCESS... :ENDPROCESS	Definition einer Schleife zur zeilenweisen Bearbeitung einer Datensequenz, wie beispielsweise den Inhalt einer sequentiellen Datei oder das textmäßige Ergebnis eines Kommandos.
GET_PROCESS_LINE	Ermittelt den aktuellen Zeileninhalt einer Datensequenz.

Script-Sprachmittel - Datensequenzen

Beispielsammlung
Endestatus aufgrund des Reportinhaltes setzen

Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung
Script-Sprachmittel - Funktionelle Gliederung

Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support