SAP IMG_EDIT_TEXT Function Module for SAPscript: Read and change text; consideration of global texts









IMG_EDIT_TEXT is a standard img edit 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 and change text; consideration of global texts 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 img edit text FM, simply by entering the name IMG_EDIT_TEXT into the relevant SAP transaction such as SE37 or SE38.

Function Group: STXD
Program Name: SAPLSTXD
Main Program: SAPLSTXD
Appliation area:
Release date: 29-Sep-1998
Mode(Normal, Remote etc): Normal Function Module
Update:



Function IMG_EDIT_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 'IMG_EDIT_TEXT'"SAPscript: Read and change text; consideration of global texts
  EXPORTING
   ID =  "Text ID of text to be read
   LANGUAGE =  "Language of text to be read
   NAME =  "Name of text to be read
*  DISPLAY = ' ' "Flag: Display mode
*  EDITOR_TITLE = ' ' "Text for editor title line
*  SAVE = 'X' "Indicator: Saving by editor
*  CONTROL = ' ' "Control parameter for the editor
*  LOCAL_CAT = ' ' "Text catalog local

 IMPORTING
   HEADER =  "Text header of text read
   FUNCTION =  "Flag: Processing status
   RESULT =  "Editor status information

TABLES
   LINES =  "Text lines of edited text

EXCEPTIONS
   ID = 1    LANGUAGE = 2    NAME = 3    NOT_FOUND = 4    REFERENCE_CHECK = 5    LINESIZE = 6    TEXTFORMAT = 7    COMMUNICATION = 8    NO_AUTHORITY = 9
.



IMPORTING Parameters details for IMG_EDIT_TEXT

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)

DISPLAY - Flag: Display mode

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

EDITOR_TITLE - Text for editor title line

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

SAVE - Indicator: Saving by editor

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

CONTROL - Control parameter for the editor

Data type: ITCED
Default: SPACE
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 IMG_EDIT_TEXT

HEADER - Text header of text read

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

FUNCTION - Flag: Processing status

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

RESULT - Editor status information

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

TABLES Parameters details for IMG_EDIT_TEXT

LINES - Text lines of edited text

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)

REFERENCE_CHECK - Reference chain interrupted

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

LINESIZE - Line width in text header invalid

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

TEXTFORMAT - Text format cannot be processed

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

COMMUNICATION - Communication error

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

NO_AUTHORITY - No authorization

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

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

DATA:
lv_id  TYPE THEAD-TDID, "   
lv_id  TYPE THEAD, "   
lt_lines  TYPE STANDARD TABLE OF TLINE, "   
lv_header  TYPE THEAD, "   
lv_function  TYPE THEAD, "   
lv_language  TYPE THEAD-TDSPRAS, "   
lv_language  TYPE THEAD, "   
lv_name  TYPE THEAD-TDNAME, "   
lv_name  TYPE THEAD, "   
lv_result  TYPE ITCER, "   
lv_display  TYPE ITCER, "   SPACE
lv_not_found  TYPE ITCER, "   
lv_editor_title  TYPE TTXIT-TDTEXT, "   SPACE
lv_reference_check  TYPE TTXIT, "   
lv_save  TYPE TTXIT, "   'X'
lv_linesize  TYPE TTXIT, "   
lv_control  TYPE ITCED, "   SPACE
lv_textformat  TYPE ITCED, "   
lv_local_cat  TYPE ITCED, "   SPACE
lv_communication  TYPE ITCED, "   
lv_no_authority  TYPE ITCED. "   

  CALL FUNCTION 'IMG_EDIT_TEXT'  "SAPscript: Read and change text; consideration of global texts
    EXPORTING
         ID = lv_id
         LANGUAGE = lv_language
         NAME = lv_name
         DISPLAY = lv_display
         EDITOR_TITLE = lv_editor_title
         SAVE = lv_save
         CONTROL = lv_control
         LOCAL_CAT = lv_local_cat
    IMPORTING
         HEADER = lv_header
         FUNCTION = lv_function
         RESULT = lv_result
    TABLES
         LINES = lt_lines
    EXCEPTIONS
        ID = 1
        LANGUAGE = 2
        NAME = 3
        NOT_FOUND = 4
        REFERENCE_CHECK = 5
        LINESIZE = 6
        TEXTFORMAT = 7
        COMMUNICATION = 8
        NO_AUTHORITY = 9
. " IMG_EDIT_TEXT




ABAP code using 7.40 inline data declarations to call FM IMG_EDIT_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.

"SELECT single TDID FROM THEAD INTO @DATA(ld_id).
 
 
 
 
 
"SELECT single TDSPRAS FROM THEAD INTO @DATA(ld_language).
 
 
"SELECT single TDNAME FROM THEAD INTO @DATA(ld_name).
 
 
 
DATA(ld_display) = ' '.
 
 
"SELECT single TDTEXT FROM TTXIT INTO @DATA(ld_editor_title).
DATA(ld_editor_title) = ' '.
 
 
DATA(ld_save) = 'X'.
 
 
DATA(ld_control) = ' '.
 
 
DATA(ld_local_cat) = ' '.
 
 
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!