READ_TEXT

READ_TEXT provides a text for the application program in the specified work areas.

The function module reads the desired text from the text file, the text memory, or the archive. You must fully specify the text using OBJECT, NAME, ID, and LANGUAGE. An internal work area can hold only one text; therefore, generic specifications are not allowed with these options.

After successful reading, the system places header information and text lines into the work areas specified with HEADER and LINES.

If a reference text is used, SAPscript automatically processes the reference chain and provides the text lines found in the text at the end of the chain. If an error occurs, the system leaves the function module and triggers the exception REFERENCE_CHECK.

Function call:

Syntax Syntax

CALL FUNCTION 'READ_TEXT'
	EXPORTING
		CLIENT		= SY-MANDT
		OBJECT		= ?...
		NAME		= ?...
		ID		= ?...
		LANGUAGE	= ?...
		ARCHIVE_HANDLE	= 0
	IMPORTING
		HEADER		=
	TABLES
		LINES		= ?...
	EXCEPTIONS
		ID		=
		LANGUAGE	=
		NAME		=
		NOT_FOUND	=
		OBJECT		=
		REFERENCE_CHECK	=
		WRONG_ACCESS_TO_ARCHIVE =

End of the code.

Export parameters:

CLIENT	Specify the client under which the text is stored. If you omit this parameter, the system uses the current client as default. Reference field: SY-MANDT Default value: SY-MANDT
OBJECT	Enter the name of the text object allocated to the text. Table TTXOB contains the valid objects. Reference field: THEAD-TDOBJECT
NAME	Enter the name of the text module. The text name can be up to 70 characters long. Its internal structure depends on the text object used. Reference field: THEAD-TDNAME
ID	Enter the text ID of the text module. Table TTXID contains the valid text IDs, depending on the text object. Reference field: THEAD-TDID
LANGUAGE	Enter the language key of the text module. The system accepts only languages that are defined in table T002. Reference field: THEAD-TDSPRAS
ARCHIVE_HANDLE	If you want to read the text from the archive, you must enter a handle here. The system needs the handle to access the archive. You can use the function module ACHIVE_OPEN_FOR_READ to create the handle. The value '0' indicates that you do not want to read the archive. Reference field: SY-TABIX Default value: 0

Import parameter:

HEADER

If the system finds the text, it returns the table header in this parameter.

Structure: THEAD

Table parameters:

LINES

The table contains all text lines that belong to the text read.

Structure: TLINE

Exceptions:

ID	The text ID specified in the parameter ID does not exist in table TTXID. It must be defined there with the text module object.
LANGUAGE	The parameter LANGUAGE contains a text language key that is not defined in table T002.
NAME	The parameter NAME contains the name of a text module that does not correspond to the SAPscript conventions. Possible errors: Field contains only blanks Field contains the invalid characters '*' or ','.
OBJECT	The parameter OBJECT contains the name of a text object that does not exist in table TTXOB.
NOT_FOUND	The system did not find the specified text module.
REFERENCE_CHECK	The text module to be read does not have any text lines, but refers to the lines of another text module. This reference chain can have several levels. For the current text, the chain is interrupted, that is, one of the text modules referred to in the chain no longer exists.
WRONG_ACCESS_ TO_ARCHIVE	The exception WRONG_ACCESS_TO_ARCHIVE is triggered if an archive is accessed using an incorrect or non-existing archive handle or an incorrect mode (that is, read if the archive is open for writing or vice versa).