PREP_PROCESS_DOCU

Verwenden Sie die Script-Funktion PREP_PROCESS_DOCU, um den Inhalt einer Dokumentationsseite aus einem Objekt abzurufen. Mit der Script-Funktion können Sie den Namen einer bestimmten Dokumentationsseite angeben. Die Script-Funktion gibt einen Verweis auf eine Datensequenz zurück, die Sie zur weiteren Verarbeitung verwenden können, indem Sie den Rückgabewert der Script-Anweisung :PROCESS zuweisen. Verwenden Sie die Script-Funktion GET_PROCESS_LINE, um auf jede Zeile in der Datensequenz zuzugreifen.

Sie können den Inhalt strukturierter oder einfacher Dokumentationsseiten (Nur Text) abrufen:

• Alle Elemente, die im Bereich der linken Registerkarte auf den strukturierten Dokumentationsseiten definiert sind, werden in der Datensequenz Zeile für Zeile gespeichert.
• Wird eine einfache Dokumentationsseite angegeben, so wird deren Inhalt (Text) zeilenweise in der Datensequenz gespeichert.

Mehr Informationen

• Seite "Dokumentation"
• UC_OBJECT_DOCU - Objektdokumentation
• :PROCESS... :TERM_PROCESS... :ENDPROCESS

Hinweis: Der Script-Variablen, die die Datensequenz-Referenz enthält, kann kein neuer Wert zugewiesen werden. Verwenden Sie :CLOSE_PROCESS, um die vorhandene Datensequenz zu verwerfen und einen neuen Wert zuzuweisen.

Syntax

PREP_PROCESS_DOCU ( Objektname, [Dokumentationsseite] )

Parameter

• PREP_PROCESS_DOCU
  Ruft den Inhalt einer Dokumentationsseite ab

• Objektname
  Name des Objekts, aus dem der Inhalt der Dokumentationsseite abgerufen wird
  Format: Script-Literal oder Script-Variable

• Dokumentationsseite
  (Optional) Name der Dokumentationsseite
  Hinweis:Bei dem Namen muss die Groß-/Kleinschreibung nicht beachtet werden.
  Format: Script-Literal oder Script-Variable
  Wenn Sie keinen Namen angeben, sucht das System nach der Standarddokumentationsseite mit dem Namen Docu.

Wichtig!

• Geben Sie den Namen des Objekts und den Namen der Dokumentationsseite genau so an, wie sie in UC_OBJECT_DOCU definiert sind.
• Das Script wird abgebrochen, wenn der Objektname ungültig ist.
• Die Script-Funktion wird nicht abgebrochen, wenn keine Dokumentationsseite mit dem angegebenen Namen vorhanden ist. In diesem Fall ist die zurückgegebene Datensequenz leer.

Beispiel

Das folgende Script ruft den Inhalt einer benutzerdefinierten Dokumentationsseite ab, die in einem Script-Objekt als Notizen bezeichnet wird. Das Script gibt den Inhalt der Seite in den Aktivierungsreport aus.

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

:CLOSE_PROCESS &HND#

Siehe auch: