PREP_PROCESS_DOCU

Script Function: Provides the content of a Documentation tab as an internal list (data sequence) for further processing.

Syntax

PREP_PROCESS_DOCU ( ObjectName, [Documentation tab] )

Syntax	Description/Format
Object name	The name of any object whose Documentation tab should be read. Format: script literal or script variable
Documentation tab	The name of the Documentation tab. Format: script literal or script variable When you do not specify a name, the system will search for the Documentation tab "Docu".

Syntax

Description/Format

Object name

The name of any object whose Documentation tab should be read.

Format: script literal or script variable

Documentation tab

The name of the Documentation tab.
Format: script literal or script variable

When you do not specify a name, the system will search for the Documentation tab "Docu".

Return Codes
A reference to the data sequence that includes the content of the required Documentation tab.

Comments

This script element reads the content of a specific Documentation tab of an object (Documentation tabs are available in all object types) and provides it as a data sequence for further processing. Note that you must specify the name of the object and the Documentation tab in the same way as it is defined in the variable UC_OBJECT_DOCU.

You can specify a structured or a simple (it includes only text) Documentation tab.
Structured Documentation tabs store all elements that are defined in the left tab area to the data sequence line by line. The content (text) of a simple Documentation tab is redirected to the data sequence line by line.

Uppercase letters and lowercase letters are ignored in Documentation-tab names. A search for "docu" will also find "Docu".

This script function will not abort when the system cannot find a Documentation tab that has the specified name. The only effect is that the data sequence will not be filled with contents in this case. The script function will only abort when the object name is not valid

Examples

The following example reads the Documentation tab "Docu" of the object SCRI.TEST and prints its content in the activation report.

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

:CLOSE_PROCESS &HND#

Script Elements	Definition
:PROCESS... :TERM_PROCESS... :ENDPROCESS	These script statements are used to define a loop for the line by line processing of a data sequence such as the content of a sequential file or the text result of a command.
GET_PROCESS_LINE	Retrieves the current line content of a data sequence.