SAP Function Modules

Share |

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


ABAP_DOCU_START is a standard SAP function module that performs Initial Screen for ABAP Documentation, Search, and Display functionality. This is available within standard R/3 SAP systems depending on version and release level.

Below are the pattern details for this FM showing its interface including any import, export and tables parameters. There is also a list of Exceptions and for your convenience any standard documentation available. All this information and more can also be viewed if you enter the function module name ABAP_DOCU_START into the relevant SAP transaction such as SE37 or SE80.

Contribute (Add Comments)
Within the comments section below there is also an opportunity for you 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: Not Released
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

SAP Documentation for FM ABAP_DOCU_START


FUNCTIONALITY

Search for terms in the ABAP keyword documentation. Display the hit list and call the documentation.

Caution
The direct usage of the function module is obsolete outside of the package SABAPDOCU. Use the method START of the CL_ABAP_DOCU class instead.

EXAMPLE


HINTS
  • After calling the module, you should set the focus to the control returned in DOCU_CONTAINER.

  • The controls used by the function module require connection to a screen. Calling outside a screen sequence (for example, in an executable program) is not useful.


  • FURTHER_SOURCES_OF_INF
    Function module ABAP_DOCU_SHOW
    Documentation extract taken from SAP system, Copyright (c) SAP AG




    comments powered by Disqus