Show TOC

TEXT_INCLUDE_REPLACELocate this document in the navigation structure

Use

This function is used to expand the INCLUDE commands in the text lines, replacing them with the lines of the text which is to be included. If a text module is not available or the user does not have the appropriate authorization, the INCLUDE command is retained.

Function call: 

CALL FUNCTION 'TEXT_INCLUDE_REPLACE'
        EXPORTING
                HEADER          = ?...
                STARTLINE       = 1
                ENDLINE         = 99999
                PROGRAM         = SPACE
                ALL_LEVEL       = 'X'
        IMPORTING
                NEWHEADER       =
                CHANGED         =
                ERROR_TYPE      =
        TABLES
                LINES           = ?...

Export parameters:

HEADER

The parameter contains the header of the text module whose INCLUDE statements you want to resolve.

Structure: THEAD

STARTLINE

Here you can specify the index of the table line from which the required function is to be effective. If no value or an invalid value is specified, the first line of the text table is used.

Reference field: SY-TABIX

Default value: 1

ENDLINE

Here you can specify the index of the last text line on which you want to use the required function. If no value or an invalid value is specified, the last line of the text table is generally used.

Reference field: SY-TABIX

Default value: 99999

PROGRAM

In order to replace program symbols, SAPscript has to know in which active program the work areas for those values that are to be adopted lie.

If you omit the parameter, the system searches for the field values in the program that was called first (SY-CPROG).

If you enter a program name, the system replaces the program symbols with the values from this program. This applies only for the current call of the function module.

Reference field: SY-REPID

Default value: SPACE

ALL_LEVEL

ALL_LEVEL can be used to determine whether the INCLUDE commands in the text table should be expanded only or whether the new INCLUDE commands which may result from this expansion should also be expanded.

Possible values:

  • ' ' Expand existing INCLUDEs only

  • 'X' Expand all INCLUDEs

Default value: 'X'

Import parameter:

NEWHEADER

The parameter returns the text header with the fields changed according to the executed actions.

Structure: THEAD

CHANGED

The parameter indicates whether the system resolved INCLUDEs and thus changed the contents of the text table.

Possible values:

  • 'X' INCLUDEs resolved

  • ' ' no INCLUDEs resolved

ERROR_TYPE

This parameter does not currently return any error messages.

Reference field: SY-TABIX

Table parameters:

LINES

The table contains the text lines in which to resolve the INCLUDE statements.

Structure: TLINE