SAP Tables

ABAP_DOCU_START SAP Function module - Initial Screen for ABAP Documentation, Search, and Display




ABAP_DOCU_STARTis a standard SAP function module available within R/3 SAPsystems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import/export parameters, exceptions etc as well as any documentation contributions specific to the object. See here to view full function module documentation and code listing, simply by entering the name ABAP_DOCU_START into the relevant SAP transaction such as SE37 or SE80.

Contribute (Add Comments)
Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name ABAP_DOCU_START or its description.


Pattern for FM ABAP_DOCU_START - ABAP DOCU START
Associated Function Group: ABAP_DOCU
Released Date: 14.12.2004
CALL FUNCTION 'ABAP_DOCU_START' "Initial Screen for ABAP Documentation, Search, and Display
* EXPORTING
*   word = ''                   " csequence     ABAP Term (Generic if Necessary)
*   first_word = ''             " csequence     First Word of Statement
*   tokens =                    " abapdocu_tokens  All Tokens of Statement
*   mode = ' '                  " csequence     'ABAP' odr 'DYNP'
*   no_dialog = ' '             " abap_bool     No Display of Selection List and Return of Table if 'X'
*   index_flag = 'X'            " abap_bool     Search in Index
*   glossary_flag = 'X'         " abap_bool     Search in Glossary
*   subjects_flag = 'X'         " abap_bool     Search in Keywords
*   examples_flag = 'X'         " abap_bool     Searching in Examples
*   full_text_flag =            " abap_bool     Full Text Search
*   langu = SY-LANGU            " sy-langu      Language for Full Text Search
*   debug_flag = ' '            " abap_bool     Special Display Mode for Calls from ABAP Debugger
*   no_similars = ' '           " abap_bool     No Similarity Search
  IMPORTING
    docu_container =            " cl_gui_control  Reference to Docomentation or Hit List Container
    structured_search_results =   " cl_abap_docu=>search_results  Structured Search Result
    search_results =            " cl_abap_docu=>search_results  Search Result if NO_DIALOG = 'X'
    .  "  ABAP_DOCU_START

ABAP code example for Function Module ABAP_DOCU_START


The ABAP code below is a full code listing to execute function module ABAP_DOCU_START including all data declarations. The code uses the latest in-line data declaration syntax but I have included an abap code snipet 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_docu_container   TYPE CL_GUI_CONTROL,
ld_structured_search_results   TYPE CL_ABAP_DOCU=>SEARCH_RESULTS,
ld_search_results   TYPE CL_ABAP_DOCU=>SEARCH_RESULTS.

DATA(ld_word) = 'Check type of data required'.
DATA(ld_first_word) = 'Check type of data required'.
DATA(ld_tokens) = 'Check type of data required'.
DATA(ld_mode) = 'Check type of data required'.
DATA(ld_no_dialog) = 'Check type of data required'.
DATA(ld_index_flag) = 'Check type of data required'.
DATA(ld_glossary_flag) = 'Check type of data required'.
DATA(ld_subjects_flag) = 'Check type of data required'.
DATA(ld_examples_flag) = 'Check type of data required'.
DATA(ld_full_text_flag) = 'Check type of data required'.
DATA(ld_langu) = 'Check type of data required'.
DATA(ld_debug_flag) = 'Check type of data required'.
DATA(ld_no_similars) = 'Check type of data required'.. CALL FUNCTION 'ABAP_DOCU_START' * EXPORTING * word = ld_word * first_word = ld_first_word * tokens = ld_tokens * mode = ld_mode * no_dialog = ld_no_dialog * 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 * langu = ld_langu * debug_flag = ld_debug_flag * no_similars = ld_no_similars IMPORTING docu_container = ld_docu_container structured_search_results = ld_structured_search_results search_results = ld_search_results . " ABAP_DOCU_START
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_docu_container TYPE CL_GUI_CONTROL ,
ld_word TYPE CSEQUENCE ,
ld_structured_search_results TYPE CL_ABAP_DOCU=>SEARCH_RESULTS ,
ld_first_word TYPE CSEQUENCE ,
ld_search_results TYPE CL_ABAP_DOCU=>SEARCH_RESULTS ,
ld_tokens TYPE ABAPDOCU_TOKENS ,
ld_mode TYPE CSEQUENCE ,
ld_no_dialog TYPE ABAP_BOOL ,
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_langu TYPE SY-LANGU ,
ld_debug_flag TYPE ABAP_BOOL ,
ld_no_similars TYPE ABAP_BOOL .


ld_docu_container = 'Check type of data required'.
ld_word = 'Check type of data required'.
ld_structured_search_results = 'Check type of data required'.
ld_first_word = 'Check type of data required'.
ld_search_results = 'Check type of data required'.
ld_tokens = 'Check type of data required'.
ld_mode = 'Check type of data required'.
ld_no_dialog = 'Check type of data required'.
ld_index_flag = 'Check type of data required'.
ld_glossary_flag = 'Check type of data required'.
ld_subjects_flag = 'Check type of data required'.
ld_examples_flag = 'Check type of data required'.
ld_full_text_flag = 'Check type of data required'.
ld_langu = 'Check type of data required'.
ld_debug_flag = 'Check type of data required'.
ld_no_similars = 'Check type of data required'..

SAP Documentation for FM ABAP_DOCU_START


Search for terms in the ABAP keyword documentation. Display the hit list and call the documentation. ...See here for full SAP fm documentation