EDITOR_HELP SAP Function module

EDITOR_HELP is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name EDITOR_HELP into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: S38E
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM EDITOR_HELP - EDITOR HELP

CALL FUNCTION 'EDITOR_HELP' "
* EXPORTING
*   abap = SPACE                "
*   application = '**'          " s38e-app_id
*   command = SPACE             "
*   display = SPACE             "
*   keyword = SPACE             "
*   object = SPACE              "
*   program = SPACE             " sy-repid
*   stmt_keyword =              " rstxp-tdanweisng  Token sequence
*   index_flag = 'X'            " abap_bool
*   glossary_flag = 'X'         " abap_bool
*   subjects_flag = 'X'         " abap_bool
*   examples_flag = 'X'         " abap_bool
*   full_text_flag =            " abap_bool
*   help_tokens =               " abapdocu_tokens
  IMPORTING
    subrc =                     " sy-subrc
    docu_container =            " cl_gui_control  Proxy Class for Control in GUI
    .  "  EDITOR_HELP

ABAP code example for Function Module EDITOR_HELP

The ABAP code below is a full code listing to execute function module EDITOR_HELP including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_subrc  
 
 TYPE SY-SUBRC
,
ld_docu_container  
 
 TYPE CL_GUI_CONTROL
.


DATA(ld_abap) = 'some text here'.


DATA(ld_application) = some text here

DATA(ld_command) = 'some text here'.

DATA(ld_display) = 'some text here'.

DATA(ld_keyword) = 'some text here'.

DATA(ld_object) = 'some text here'.

DATA(ld_program) = 'Check type of data required'.


DATA(ld_stmt_keyword) = some text here

DATA(ld_index_flag) = 'some text here'.

DATA(ld_glossary_flag) = 'some text here'.

DATA(ld_subjects_flag) = 'some text here'.

DATA(ld_examples_flag) = 'some text here'.

DATA(ld_full_text_flag) = 'some text here'.

DATA(ld_help_tokens) = 'some text here'.
.

CALL FUNCTION 'EDITOR_HELP'
* EXPORTING
*   abap =                       ld_abap
*   application =                ld_application
*   command =                    ld_command
*   display =                    ld_display
*   keyword =                    ld_keyword
*   object =                     ld_object
*   program =                    ld_program
*   stmt_keyword =               ld_stmt_keyword
*   index_flag =                 ld_index_flag
*   glossary_flag =              ld_glossary_flag
*   subjects_flag =              ld_subjects_flag
*   examples_flag =              ld_examples_flag
*   full_text_flag =             ld_full_text_flag
*   help_tokens =                ld_help_tokens
  IMPORTING
    subrc =                      ld_subrc
    docu_container =             ld_docu_container
    .  "  EDITOR_HELP

IF SY-SUBRC EQ 0.
  "All OK
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_subrc
 
 TYPE SY-SUBRC ,
ld_abap
 
 TYPE STRING ,
ld_docu_container
 
 TYPE CL_GUI_CONTROL ,
ld_application
 
 TYPE S38E-APP_ID ,
ld_command
 
 TYPE STRING ,
ld_display
 
 TYPE STRING ,
ld_keyword
 
 TYPE STRING ,
ld_object
 
 TYPE STRING ,
ld_program
 
 TYPE SY-REPID ,
ld_stmt_keyword
 
 TYPE RSTXP-TDANWEISNG ,
ld_index_flag
 
 TYPE ABAP_BOOL ,
ld_glossary_flag
 
 TYPE ABAP_BOOL ,
ld_subjects_flag
 
 TYPE ABAP_BOOL ,
ld_examples_flag
 
 TYPE ABAP_BOOL ,
ld_full_text_flag
 
 TYPE ABAP_BOOL ,
ld_help_tokens
 
 TYPE ABAPDOCU_TOKENS .


ld_abap = 'some text here'.

ld_application = some text here
ld_command = 'some text here'.
ld_display = 'some text here'.
ld_keyword = 'some text here'.
ld_object = 'some text here'.
ld_program = 'Check type of data required'.

ld_stmt_keyword = some text here
ld_index_flag = 'some text here'.
ld_glossary_flag = 'some text here'.
ld_subjects_flag = 'some text here'.
ld_examples_flag = 'some text here'.
ld_full_text_flag = 'some text here'.
ld_help_tokens = 'some text here'.