SAP READ_TEXT Function Module for SAPscript: Read text

Search SAP Function Modules

READ_TEXT is a standard read text SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for SAPscript: Read text processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.

See here to view full function module documentation and code listing for read text FM, simply by entering the name READ_TEXT into the relevant SAP transaction such as SE37 or SE38.

Function Group: STXD
Program Name: SAPLSTXD
Main Program: SAPLSTXD
Appliation area:
Release date: 16-Jan-1995
Mode(Normal, Remote etc): Normal Function Module
Update:

Function READ_TEXT pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.

CALL FUNCTION 'READ_TEXT'"SAPscript: Read text
  EXPORTING
*  CLIENT = SY-MANDT "Client
   ID =  "Text ID of text to be read
   LANGUAGE =  "Language of text to be read
   NAME =  "Name of text to be read
   OBJECT =  "Object of text to be read
*  ARCHIVE_HANDLE = 0 "Archive Handle
*  LOCAL_CAT = ' ' "Text catalog local

 IMPORTING
   HEADER =  "Text header of text read
   OLD_LINE_COUNTER =  "Original Number of Text Lines

TABLES
   LINES =  "Lines of text read

EXCEPTIONS
   ID = 1    LANGUAGE = 2    NAME = 3    NOT_FOUND = 4    OBJECT = 5    REFERENCE_CHECK = 6    WRONG_ACCESS_TO_ARCHIVE = 7 

.

IMPORTING Parameters details for READ_TEXT

CLIENT - Client

Data type: SY-MANDT
Default: SY-MANDT
Optional: Yes
Call by Reference: No ( called with pass by value option)

ID - Text ID of text to be read

Data type: THEAD-TDID
Optional: No
Call by Reference: No ( called with pass by value option)

LANGUAGE - Language of text to be read

Data type: THEAD-TDSPRAS
Optional: No
Call by Reference: No ( called with pass by value option)

NAME - Name of text to be read

Data type: THEAD-TDNAME
Optional: No
Call by Reference: No ( called with pass by value option)

OBJECT - Object of text to be read

Data type: THEAD-TDOBJECT
Optional: No
Call by Reference: No ( called with pass by value option)

ARCHIVE_HANDLE - Archive Handle

Data type: SY-TABIX
Optional: Yes
Call by Reference: No ( called with pass by value option)

LOCAL_CAT - Text catalog local

Data type:
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for READ_TEXT

HEADER - Text header of text read

Data type: THEAD
Optional: No
Call by Reference: No ( called with pass by value option)

OLD_LINE_COUNTER - Original Number of Text Lines

Data type: THEAD-TDTXTLINES
Optional: No
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for READ_TEXT

LINES - Lines of text read

Data type: TLINE
Optional: No
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

ID - Text ID of text to be read

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

LANGUAGE - Language of text to be read

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

NAME - Name of text to be read

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

NOT_FOUND - Text not found

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

OBJECT - Object of text to be read

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

REFERENCE_CHECK - Reference chain interrupted

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

WRONG_ACCESS_TO_ARCHIVE - Archive handle invalid for access

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for READ_TEXT Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

ABAP code using 7.40 inline data declarations to call FM READ_TEXT

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

Search for further information about these or an SAP related objects