SAP DOCU_WINHELP_SHOW Function Module for Documentation: Call the WinHelp files on CD ROM









DOCU_WINHELP_SHOW is a standard docu winhelp show SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Documentation: Call the WinHelp files on CD ROM processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for docu winhelp show FM, simply by entering the name DOCU_WINHELP_SHOW into the relevant SAP transaction such as SE37 or SE38.

Function Group: SDOI
Program Name: SAPLSDOI
Main Program: SAPLSDOI
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function DOCU_WINHELP_SHOW pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'DOCU_WINHELP_SHOW'"Documentation: Call the WinHelp files on CD ROM
  EXPORTING
*  DEVCLASS = ' ' "Development class
*  TCODE = ' ' "
*  _THEXC = ' ' "
*  SUPPRESS_BOOKLIST = ' ' "
*  HELP_INFO_LOCAL = ' ' "
*  GET_EXE_INFO_ONLY = ' ' "

 IMPORTING
   EXECUTABLE =  "
   CMDLINE =  "

EXCEPTIONS
   DOCUMENTATION_NOT_AVAILABLE = 1    WRONG_OPERATION_SYSTEM = 2
.



IMPORTING Parameters details for DOCU_WINHELP_SHOW

DEVCLASS - Development class

Data type: THLPG-DEVCLASS
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

TCODE -

Data type: TSTC-TCODE
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

_THEXC -

Data type: THEXC
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

SUPPRESS_BOOKLIST -

Data type: SY-BATCH
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

HELP_INFO_LOCAL -

Data type: HELP_INFO
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

GET_EXE_INFO_ONLY -

Data type: SY-BATCH
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for DOCU_WINHELP_SHOW

EXECUTABLE -

Data type: HLP_EXEDAT-EXECUTABLE
Optional: No
Call by Reference: No ( called with pass by value option)

CMDLINE -

Data type: HLP_EXEDAT-CMDLINE
Optional: No
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

DOCUMENTATION_NOT_AVAILABLE - No documentation available

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

WRONG_OPERATION_SYSTEM - Operating system is not supported

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for DOCU_WINHELP_SHOW Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than 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 newer method of declaring data variables on the fly. 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), which i why i have stuck to the origianl for this example.

DATA:
lv_devclass  TYPE THLPG-DEVCLASS, "   SPACE
lv_executable  TYPE HLP_EXEDAT-EXECUTABLE, "   
lv_documentation_not_available  TYPE HLP_EXEDAT, "   
lv_tcode  TYPE TSTC-TCODE, "   SPACE
lv_cmdline  TYPE HLP_EXEDAT-CMDLINE, "   
lv_wrong_operation_system  TYPE HLP_EXEDAT, "   
lv__thexc  TYPE THEXC, "   SPACE
lv_suppress_booklist  TYPE SY-BATCH, "   SPACE
lv_help_info_local  TYPE HELP_INFO, "   SPACE
lv_get_exe_info_only  TYPE SY-BATCH. "   SPACE

  CALL FUNCTION 'DOCU_WINHELP_SHOW'  "Documentation: Call the WinHelp files on CD ROM
    EXPORTING
         DEVCLASS = lv_devclass
         TCODE = lv_tcode
         _THEXC = lv__thexc
         SUPPRESS_BOOKLIST = lv_suppress_booklist
         HELP_INFO_LOCAL = lv_help_info_local
         GET_EXE_INFO_ONLY = lv_get_exe_info_only
    IMPORTING
         EXECUTABLE = lv_executable
         CMDLINE = lv_cmdline
    EXCEPTIONS
        DOCUMENTATION_NOT_AVAILABLE = 1
        WRONG_OPERATION_SYSTEM = 2
. " DOCU_WINHELP_SHOW




ABAP code using 7.40 inline data declarations to call FM DOCU_WINHELP_SHOW

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

"SELECT single DEVCLASS FROM THLPG INTO @DATA(ld_devclass).
DATA(ld_devclass) = ' '.
 
"SELECT single EXECUTABLE FROM HLP_EXEDAT INTO @DATA(ld_executable).
 
 
"SELECT single TCODE FROM TSTC INTO @DATA(ld_tcode).
DATA(ld_tcode) = ' '.
 
"SELECT single CMDLINE FROM HLP_EXEDAT INTO @DATA(ld_cmdline).
 
 
DATA(ld__thexc) = ' '.
 
"SELECT single BATCH FROM SY INTO @DATA(ld_suppress_booklist).
DATA(ld_suppress_booklist) = ' '.
 
DATA(ld_help_info_local) = ' '.
 
"SELECT single BATCH FROM SY INTO @DATA(ld_get_exe_info_only).
DATA(ld_get_exe_info_only) = ' '.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!