SAP CNTX_SOI_READ_TEXT Function Module for NOTRANSL: PS-Text Lesen

Search SAP Function Modules

CNTX_SOI_READ_TEXT is a standard cntx soi 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 NOTRANSL: PS-Text Lesen 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 cntx soi read text FM, simply by entering the name CNTX_SOI_READ_TEXT into the relevant SAP transaction such as SE37 or SE38.

Function Group: CNTX_SOI
Program Name: SAPLCNTX_SOI
Main Program: SAPLCNTX_SOI
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:

Function CNTX_SOI_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 'CNTX_SOI_READ_TEXT'"NOTRANSL: PS-Text Lesen
  EXPORTING
*  CLIENT = SY-MANDT "SAP System, Client Number from Logon
   ID =  "Text ID
   LANGUAGE =  "Language Key
   NAME =  "Name
   OBJECT =  "Texts: Application Object
*  ARCHIVE_HANDLE =  "Internal Tables, Current Row Index
*  LOCAL_CAT =  "

 IMPORTING
   HEADER =  "SAPscript: Text Header

TABLES
   LINES =  "SAPscript: Text Lines
   BLINES =  "SAPscript: Text Lines

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

.

IMPORTING Parameters details for CNTX_SOI_READ_TEXT

CLIENT - SAP System, Client Number from Logon

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

ID - Text ID

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

LANGUAGE - Language Key

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

NAME - Name

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

OBJECT - Texts: Application Object

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

ARCHIVE_HANDLE - Internal Tables, Current Row Index

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

LOCAL_CAT -

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

EXPORTING Parameters details for CNTX_SOI_READ_TEXT

HEADER - SAPscript: Text Header

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

TABLES Parameters details for CNTX_SOI_READ_TEXT

LINES - SAPscript: Text Lines

Data type: TLINE
Optional: No
Call by Reference: Yes

BLINES - SAPscript: Text Lines

Data type: CNSOI_BYTELINE
Optional: No
Call by Reference: Yes

EXCEPTIONS details

ID - Text ID

Data type:
Optional: No
Call by Reference: Yes

LANGUAGE - Language Key

Data type:
Optional: No
Call by Reference: Yes

NAME - Name

Data type:
Optional: No
Call by Reference: Yes

NOT_FOUND - Text not found

Data type:
Optional: No
Call by Reference: Yes

OBJECT - Texts: Application Object

Data type:
Optional: No
Call by Reference: Yes

REFERENCE_CHECK - Reference chain interrupted

Data type:
Optional: No
Call by Reference: Yes

WRONG_ACCESS_TO_ARCHIVE - Archive handle invalid for access

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for CNTX_SOI_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 CNTX_SOI_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