DOCU_WINHELP_SHOW SAP Function module - Documentation: Call the WinHelp files on CD ROM

DOCU_WINHELP_SHOW 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 DOCU_WINHELP_SHOW into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SDOI
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM DOCU_WINHELP_SHOW - DOCU WINHELP SHOW

CALL FUNCTION 'DOCU_WINHELP_SHOW' "Documentation: Call the WinHelp files on CD ROM
* EXPORTING
*   devclass = SPACE            " thlpg-devclass  Development class
*   tcode = SPACE               " tstc-tcode
*   _thexc = SPACE              " thexc
*   suppress_booklist = SPACE   " sy-batch
*   help_info_local = SPACE     " help_info
*   get_exe_info_only = SPACE   " sy-batch
  IMPORTING
    executable =                " hlp_exedat-executable
    cmdline =                   " hlp_exedat-cmdline
  EXCEPTIONS
    DOCUMENTATION_NOT_AVAILABLE = 1  "          No documentation available
    WRONG_OPERATION_SYSTEM = 2  "               Operating system is not supported
    .  "  DOCU_WINHELP_SHOW

ABAP code example for Function Module DOCU_WINHELP_SHOW

The ABAP code below is a full code listing to execute function module DOCU_WINHELP_SHOW 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_executable  
 
 TYPE HLP_EXEDAT-EXECUTABLE
,
ld_cmdline  
 
 TYPE HLP_EXEDAT-CMDLINE
.

 

SELECT single DEVCLASS 
  FROM THLPG 
  INTO @DATA(ld_devclass).

 

SELECT single TCODE 
  FROM TSTC 
  INTO @DATA(ld_tcode).


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

DATA(ld_suppress_booklist) = 'some text here'.

DATA(ld_help_info_local) = 'some text here'.

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

CALL FUNCTION 'DOCU_WINHELP_SHOW'
* EXPORTING
*   devclass =                   ld_devclass
*   tcode =                      ld_tcode
*   _thexc =                     ld__thexc
*   suppress_booklist =          ld_suppress_booklist
*   help_info_local =            ld_help_info_local
*   get_exe_info_only =          ld_get_exe_info_only
  IMPORTING
    executable =                 ld_executable
    cmdline =                    ld_cmdline
  EXCEPTIONS
    DOCUMENTATION_NOT_AVAILABLE =    1
    WRONG_OPERATION_SYSTEM =     2
    .  "  DOCU_WINHELP_SHOW

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
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_executable
 
 TYPE HLP_EXEDAT-EXECUTABLE ,
ld_devclass
 
 TYPE THLPG-DEVCLASS ,
ld_cmdline
 
 TYPE HLP_EXEDAT-CMDLINE ,
ld_tcode
 
 TYPE TSTC-TCODE ,
ld__thexc
 
 TYPE THEXC ,
ld_suppress_booklist
 
 TYPE SY-BATCH ,
ld_help_info_local
 
 TYPE HELP_INFO ,
ld_get_exe_info_only
 
 TYPE SY-BATCH .



SELECT single DEVCLASS 
  FROM THLPG 
  INTO ld_devclass.


SELECT single TCODE 
  FROM TSTC 
  INTO ld_tcode.

ld__thexc = 'some text here'.
ld_suppress_booklist = 'some text here'.
ld_help_info_local = 'some text here'.
ld_get_exe_info_only = 'some text here'.