SAP Function ABAP_DOCU_SHOW - Display ABAP Keyword Documentation

Parameter Reference Type Length Default Optional Text
ANCHOR C C 0 X Internal Text Mark for Direct Control
AREA C C 0 'ABEN' X Documentation Area
LANGU SYST-LANGU C 1 SY-LANGU X Language
NAME C C 0 'ABAP' X Document Name
SEARCHED STANDARD TABLE 0 X Search Terms for Full Text Search
SEARCH_MODE C C 0 X I, F for Index, Full Ttext
SEARCH_WORD CSEQUENCE C 0 X Search argument

Parameter Reference Type Length Text
DOCU_CONTAINER REF TO CL_GUI_CONTROL 0 Reference to Control

Description
Display of keyword documentation in HTML control. The display depends onthe user settings in the table ABDOCMODE (E: modeless dialog box, I:same box, M: one common external session for all external sessions).

Caution
Using the function module directly outside of the package SABAPDOCU isobsolete. Use the method SHOW of the CL_ABAP_DOCU class instead.

  • AREA, Appropriate values are ABEN, ABAP, DYNP

  • NAME, Appropriate values are names of keywords such as MODULE

  • LANGU, Language key

  • ANCHOR, Internal marker, should be suitably transferred

    • The default values for the IMPORTING parameters are ABEN, ABAP,SY-LANGU.

    EXPORTING Parameter

    • DOCU_CONTAINER, if display mode E (modless dialog box), reference to
      • HTML control, otherwise initial.

      Note on Use
      It is sensible to set the focus to the HTML control after calling thefunction module and during the PBO event of the subsequent screen:
      IF NOT docu_container IS INITIAL.
      CALL METHOD cl_gui_control=>set_focus
      EXPORTING control = docu_container.
      CLEAR docu_container.
      ENDIF.

      Caution
      The controls used by the function module require a connection to ascreen. Calling outside a screen sequence (for example, in an executableprogram) is not useful if the documentation is displayed in an amodalwindow.