SAP EDITOR_HELP Function Module for









EDITOR_HELP is a standard editor help SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 editor help FM, simply by entering the name EDITOR_HELP into the relevant SAP transaction such as SE37 or SE38.

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



Function EDITOR_HELP 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 'EDITOR_HELP'"
EXPORTING
* ABAP = ' ' "
* GLOSSARY_FLAG = 'X' "
* SUBJECTS_FLAG = 'X' "
* EXAMPLES_FLAG = 'X' "
* FULL_TEXT_FLAG = "
* HELP_TOKENS = "
* APPLICATION = '**' "
* COMMAND = ' ' "
* DISPLAY = ' ' "
* KEYWORD = ' ' "
* OBJECT = ' ' "
* PROGRAM = ' ' "
* STMT_KEYWORD = "Token sequence
* INDEX_FLAG = 'X' "

IMPORTING
SUBRC = "
DOCU_CONTAINER = "Proxy Class for Control in GUI
.




Customer Function user exits

Below is a list of CUSTOMER FUNCTION exit user exits that are available within this program and maybe relevant for this FM.
EXIT_SAPLS38E_001 Exit for ABAP Editor

IMPORTING Parameters details for EDITOR_HELP

ABAP -

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

GLOSSARY_FLAG -

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

SUBJECTS_FLAG -

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

EXAMPLES_FLAG -

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

FULL_TEXT_FLAG -

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

HELP_TOKENS -

Data type: ABAPDOCU_TOKENS
Optional: Yes
Call by Reference: Yes

APPLICATION -

Data type: S38E-APP_ID
Default: '**'
Optional: Yes
Call by Reference: No ( called with pass by value option)

COMMAND -

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

DISPLAY -

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

KEYWORD -

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

OBJECT -

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

PROGRAM -

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

STMT_KEYWORD - Token sequence

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

INDEX_FLAG -

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

EXPORTING Parameters details for EDITOR_HELP

SUBRC -

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

DOCU_CONTAINER - Proxy Class for Control in GUI

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

Copy and paste ABAP code example for EDITOR_HELP 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_abap  TYPE STRING, "   SPACE
lv_subrc  TYPE SY-SUBRC, "   
lv_glossary_flag  TYPE ABAP_BOOL, "   'X'
lv_subjects_flag  TYPE ABAP_BOOL, "   'X'
lv_examples_flag  TYPE ABAP_BOOL, "   'X'
lv_full_text_flag  TYPE ABAP_BOOL, "   
lv_help_tokens  TYPE ABAPDOCU_TOKENS, "   
lv_application  TYPE S38E-APP_ID, "   '**'
lv_docu_container  TYPE CL_GUI_CONTROL, "   
lv_command  TYPE CL_GUI_CONTROL, "   SPACE
lv_display  TYPE CL_GUI_CONTROL, "   SPACE
lv_keyword  TYPE CL_GUI_CONTROL, "   SPACE
lv_object  TYPE CL_GUI_CONTROL, "   SPACE
lv_program  TYPE SY-REPID, "   SPACE
lv_stmt_keyword  TYPE RSTXP-TDANWEISNG, "   
lv_index_flag  TYPE ABAP_BOOL. "   'X'

  CALL FUNCTION 'EDITOR_HELP'  "
    EXPORTING
         ABAP = lv_abap
         GLOSSARY_FLAG = lv_glossary_flag
         SUBJECTS_FLAG = lv_subjects_flag
         EXAMPLES_FLAG = lv_examples_flag
         FULL_TEXT_FLAG = lv_full_text_flag
         HELP_TOKENS = lv_help_tokens
         APPLICATION = lv_application
         COMMAND = lv_command
         DISPLAY = lv_display
         KEYWORD = lv_keyword
         OBJECT = lv_object
         PROGRAM = lv_program
         STMT_KEYWORD = lv_stmt_keyword
         INDEX_FLAG = lv_index_flag
    IMPORTING
         SUBRC = lv_subrc
         DOCU_CONTAINER = lv_docu_container
. " EDITOR_HELP




ABAP code using 7.40 inline data declarations to call FM EDITOR_HELP

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.

DATA(ld_abap) = ' '.
 
"SELECT single SUBRC FROM SY INTO @DATA(ld_subrc).
 
DATA(ld_glossary_flag) = 'X'.
 
DATA(ld_subjects_flag) = 'X'.
 
DATA(ld_examples_flag) = 'X'.
 
 
 
"SELECT single APP_ID FROM S38E INTO @DATA(ld_application).
DATA(ld_application) = '**'.
 
 
DATA(ld_command) = ' '.
 
DATA(ld_display) = ' '.
 
DATA(ld_keyword) = ' '.
 
DATA(ld_object) = ' '.
 
"SELECT single REPID FROM SY INTO @DATA(ld_program).
DATA(ld_program) = ' '.
 
"SELECT single TDANWEISNG FROM RSTXP INTO @DATA(ld_stmt_keyword).
 
DATA(ld_index_flag) = 'X'.
 


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!