SAP HELP_OBJECT_SHOW Function Module for









HELP_OBJECT_SHOW is a standard help object show SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 help object show FM, simply by entering the name HELP_OBJECT_SHOW into the relevant SAP transaction such as SE37 or SE38.

Function Group: SHL2
Program Name: SAPLSHL2
Main Program: SAPLSHL2
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function HELP_OBJECT_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 'HELP_OBJECT_SHOW'"
  EXPORTING
   DOKCLASS =  "Document class
*  MSG_VAR_1 = ' ' "Message: Variable 1
*  MSG_VAR_2 = ' ' "Message: Variable 2
*  MSG_VAR_3 = ' ' "Message: Variable 3
*  MSG_VAR_4 = ' ' "Message: Variable 4
*  CALLED_BY_CUAPROG = ' ' "
*  CALLED_BY_CUASTAT =  "
*  SHORT_TEXT = ' ' "
*  CLASSIC_SAPSCRIPT = ' ' "
*  DOKLANGU = SY-LANGU "Language, for help -> always Sy-Langu
   DOKNAME =  "Document name
*  DOKTITLE = ' ' "Window title
*  CALLED_BY_PROGRAM = ' ' "calling program
*  CALLED_BY_DYNP = ' ' "calling screen
*  CALLED_FOR_TAB = ' ' "Field: Reference table
*  CALLED_FOR_FIELD = ' ' "Field name
*  CALLED_FOR_TAB_FLD_BTCH_INPUT = ' ' "Batch input relevance structure/field

TABLES
   LINKS =  "No use

EXCEPTIONS
   OBJECT_NOT_FOUND = 1    SAPSCRIPT_ERROR = 2
.



IMPORTING Parameters details for HELP_OBJECT_SHOW

DOKCLASS - Document class

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

MSG_VAR_1 - Message: Variable 1

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

MSG_VAR_2 - Message: Variable 2

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

MSG_VAR_3 - Message: Variable 3

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

MSG_VAR_4 - Message: Variable 4

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

CALLED_BY_CUAPROG -

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

CALLED_BY_CUASTAT -

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

SHORT_TEXT -

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

CLASSIC_SAPSCRIPT -

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

DOKLANGU - Language, for help -> always Sy-Langu

Data type: DSYSH-DOKLANGU
Default: SY-LANGU
Optional: Yes
Call by Reference: No ( called with pass by value option)

DOKNAME - Document name

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

DOKTITLE - Window title

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

CALLED_BY_PROGRAM - calling program

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

CALLED_BY_DYNP - calling screen

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

CALLED_FOR_TAB - Field: Reference table

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

CALLED_FOR_FIELD - Field name

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

CALLED_FOR_TAB_FLD_BTCH_INPUT - Batch input relevance structure/field

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

TABLES Parameters details for HELP_OBJECT_SHOW

LINKS - No use

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

EXCEPTIONS details

OBJECT_NOT_FOUND -

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

SAPSCRIPT_ERROR -

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

Copy and paste ABAP code example for HELP_OBJECT_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:
lt_links  TYPE STANDARD TABLE OF TLINE, "   
lv_dokclass  TYPE DSYSH-DOKCLASS, "   
lv_object_not_found  TYPE DSYSH, "   
lv_msg_var_1  TYPE DSYSH, "   SPACE
lv_msg_var_2  TYPE DSYSH, "   SPACE
lv_msg_var_3  TYPE DSYSH, "   SPACE
lv_msg_var_4  TYPE DSYSH, "   SPACE
lv_called_by_cuaprog  TYPE HELP_INFO-PROGRAM, "   SPACE
lv_called_by_cuastat  TYPE HELP_INFO-PFKEY, "   
lv_short_text  TYPE SY-BATCH, "   SPACE
lv_classic_sapscript  TYPE CHAR1, "   SPACE
lv_doklangu  TYPE DSYSH-DOKLANGU, "   SY-LANGU
lv_sapscript_error  TYPE DSYSH, "   
lv_dokname  TYPE DSYSH, "   
lv_doktitle  TYPE DSYST-DOKTITLE, "   SPACE
lv_called_by_program  TYPE HELP_INFO-PROGRAM, "   SPACE
lv_called_by_dynp  TYPE HELP_INFO-DYNPRO, "   SPACE
lv_called_for_tab  TYPE HELP_INFO-TABNAME, "   SPACE
lv_called_for_field  TYPE HELP_INFO-FIELDNAME, "   SPACE
lv_called_for_tab_fld_btch_input  TYPE HELP_INFO-DYNPROFLD. "   SPACE

  CALL FUNCTION 'HELP_OBJECT_SHOW'  "
    EXPORTING
         DOKCLASS = lv_dokclass
         MSG_VAR_1 = lv_msg_var_1
         MSG_VAR_2 = lv_msg_var_2
         MSG_VAR_3 = lv_msg_var_3
         MSG_VAR_4 = lv_msg_var_4
         CALLED_BY_CUAPROG = lv_called_by_cuaprog
         CALLED_BY_CUASTAT = lv_called_by_cuastat
         SHORT_TEXT = lv_short_text
         CLASSIC_SAPSCRIPT = lv_classic_sapscript
         DOKLANGU = lv_doklangu
         DOKNAME = lv_dokname
         DOKTITLE = lv_doktitle
         CALLED_BY_PROGRAM = lv_called_by_program
         CALLED_BY_DYNP = lv_called_by_dynp
         CALLED_FOR_TAB = lv_called_for_tab
         CALLED_FOR_FIELD = lv_called_for_field
         CALLED_FOR_TAB_FLD_BTCH_INPUT = lv_called_for_tab_fld_btch_input
    TABLES
         LINKS = lt_links
    EXCEPTIONS
        OBJECT_NOT_FOUND = 1
        SAPSCRIPT_ERROR = 2
. " HELP_OBJECT_SHOW




ABAP code using 7.40 inline data declarations to call FM HELP_OBJECT_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 DOKCLASS FROM DSYSH INTO @DATA(ld_dokclass).
 
 
DATA(ld_msg_var_1) = ' '.
 
DATA(ld_msg_var_2) = ' '.
 
DATA(ld_msg_var_3) = ' '.
 
DATA(ld_msg_var_4) = ' '.
 
"SELECT single PROGRAM FROM HELP_INFO INTO @DATA(ld_called_by_cuaprog).
DATA(ld_called_by_cuaprog) = ' '.
 
"SELECT single PFKEY FROM HELP_INFO INTO @DATA(ld_called_by_cuastat).
 
"SELECT single BATCH FROM SY INTO @DATA(ld_short_text).
DATA(ld_short_text) = ' '.
 
DATA(ld_classic_sapscript) = ' '.
 
"SELECT single DOKLANGU FROM DSYSH INTO @DATA(ld_doklangu).
DATA(ld_doklangu) = SY-LANGU.
 
 
 
"SELECT single DOKTITLE FROM DSYST INTO @DATA(ld_doktitle).
DATA(ld_doktitle) = ' '.
 
"SELECT single PROGRAM FROM HELP_INFO INTO @DATA(ld_called_by_program).
DATA(ld_called_by_program) = ' '.
 
"SELECT single DYNPRO FROM HELP_INFO INTO @DATA(ld_called_by_dynp).
DATA(ld_called_by_dynp) = ' '.
 
"SELECT single TABNAME FROM HELP_INFO INTO @DATA(ld_called_for_tab).
DATA(ld_called_for_tab) = ' '.
 
"SELECT single FIELDNAME FROM HELP_INFO INTO @DATA(ld_called_for_field).
DATA(ld_called_for_field) = ' '.
 
"SELECT single DYNPROFLD FROM HELP_INFO INTO @DATA(ld_called_for_tab_fld_btch_input).
DATA(ld_called_for_tab_fld_btch_input) = ' '.
 


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!