Script-Funktion: Liefert den Inhalt der Seite „Dokumentation“ als interne Liste (Datensequenz) zur weiteren Verarbeitung.
Syntax
PREP_PROCESS_DOCU ( ObjectName, [Documentation tab] )
|
Syntax |
Beschreibung/Format |
|---|---|
|
ObjectName |
Name eines beliebigen Objektes, dessen Dokumentations-Seite ausgelesen werden soll. Format: Script-Literal oder Script-Variable |
|
Documentation tab |
Name der Dokumentations-Seite Erfolgt keine Angabe, so wird nach einer Dokumentations-Seite mit dem Namen "Docu" gesucht. |
|
Rückgabewerte |
|---|
|
Verweis auf die Datensequenz, welche den Inhalt der gewünschten Dokumentation-Seite enthält. |
Das Sprachmittel liest den Inhalt einer bestimmten Dokumentations-Seite eines Objektes aus (Dokumentations-Seiten 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-Seite (wie in der Variable UC_OBJECT_DOCU definiert).
Dabei kann sowohl eine strukturierte als auch eine einfache Doku-Seite angegeben werden (= enthält nur Text).
Bei einer strukturierten Doku-Seite, werden alle Elemente, die im linken Bereich der Seite definiert sind, zeilenweise in die Datensequenz abgespeichert. Wird eine einfache Doku-Seite angegeben, so wird deren Inhalt (Text) zeilenweise in die Datensequenz umgeleitet.
Bei der Angabe des Namens der Dokumentations-Seite spielt Groß- und Kleinschreibung keine Rolle. Wird nach "docu" gesucht, wird die Seite "Docu" trotzdem gefunden.
Wird keine Dokumentations-Seite 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-Seite "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: