SAP DOCU_GET_FOR_F1HELP Function Module for Interface from ABAP/4 similar to 'READ DOCUMENTATION'









DOCU_GET_FOR_F1HELP is a standard docu get for f1help SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Interface from ABAP/4 similar to 'READ DOCUMENTATION' 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 get for f1help FM, simply by entering the name DOCU_GET_FOR_F1HELP into the relevant SAP transaction such as SE37 or SE38.

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



Function DOCU_GET_FOR_F1HELP 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_GET_FOR_F1HELP'"Interface from ABAP/4 similar to 'READ DOCUMENTATION'
EXPORTING
ID = "Documentation class
LANGU = "Language
OBJECT = "Documentation module name
* TYP = 'E' "Documentation type

IMPORTING
DOKSTATE = "Documentation module status
HEAD = "SAPscript documentation module information

TABLES
LINE = "Documentation module contents

EXCEPTIONS
RET_CODE = 1
.



IMPORTING Parameters details for DOCU_GET_FOR_F1HELP

ID - Documentation class

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

LANGU - Language

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

OBJECT - Documentation module name

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

TYP - Documentation type

Data type: DOKHL-TYP
Default: 'E'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for DOCU_GET_FOR_F1HELP

DOKSTATE - Documentation module status

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

HEAD - SAPscript documentation module information

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

TABLES Parameters details for DOCU_GET_FOR_F1HELP

LINE - Documentation module contents

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

EXCEPTIONS details

RET_CODE - Return code - module not found

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

Copy and paste ABAP code example for DOCU_GET_FOR_F1HELP 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_id  TYPE DOKHL-ID, "   
lt_line  TYPE STANDARD TABLE OF TLINE, "   
lv_dokstate  TYPE DOKHL-DOKSTATE, "   
lv_ret_code  TYPE DOKHL, "   
lv_head  TYPE THEAD, "   
lv_langu  TYPE SY-LANGU, "   
lv_object  TYPE DOKHL-OBJECT, "   
lv_typ  TYPE DOKHL-TYP. "   'E'

  CALL FUNCTION 'DOCU_GET_FOR_F1HELP'  "Interface from ABAP/4 similar to 'READ DOCUMENTATION'
    EXPORTING
         ID = lv_id
         LANGU = lv_langu
         OBJECT = lv_object
         TYP = lv_typ
    IMPORTING
         DOKSTATE = lv_dokstate
         HEAD = lv_head
    TABLES
         LINE = lt_line
    EXCEPTIONS
        RET_CODE = 1
. " DOCU_GET_FOR_F1HELP




ABAP code using 7.40 inline data declarations to call FM DOCU_GET_FOR_F1HELP

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 ID FROM DOKHL INTO @DATA(ld_id).
 
 
"SELECT single DOKSTATE FROM DOKHL INTO @DATA(ld_dokstate).
 
 
 
"SELECT single LANGU FROM SY INTO @DATA(ld_langu).
 
"SELECT single OBJECT FROM DOKHL INTO @DATA(ld_object).
 
"SELECT single TYP FROM DOKHL INTO @DATA(ld_typ).
DATA(ld_typ) = 'E'.
 


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!