SAP BAPI_INTERFACE_GETDOCU Function Module for Read BAPI Interface Documentation









BAPI_INTERFACE_GETDOCU is a standard bapi interface getdocu SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read BAPI Interface 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 bapi interface getdocu FM, simply by entering the name BAPI_INTERFACE_GETDOCU into the relevant SAP transaction such as SE37 or SE38.

Function Group: BATG
Program Name: SAPLBATG
Main Program: SAPLBATG
Appliation area: S
Release date: 16-Dec-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function BAPI_INTERFACE_GETDOCU 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 'BAPI_INTERFACE_GETDOCU'"Read BAPI Interface Documentation
  EXPORTING
*  OBJTYPE =  "Object type
*  OBJNAME =  "Object Name
*  METHOD =  "Method name of object type
*  PARAMETER =  "Name of parameter in method
*  FIELD =  "Field name in the parameter for F4 values
*  LANGUAGE = SY-LANGU "Language of text to be displayed
   TEXTFORMAT =  "Format of text to be displayed
*  LINKPATTERN = ' ' "Convert SAPscript Hyperlinks to HTML

 IMPORTING
   RETURN =  "Return Messages

TABLES
   TEXT =  "Table for the text
.



IMPORTING Parameters details for BAPI_INTERFACE_GETDOCU

OBJTYPE - Object type

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

OBJNAME - Object Name

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

METHOD - Method name of object type

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

PARAMETER - Name of parameter in method

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

FIELD - Field name in the parameter for F4 values

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

LANGUAGE - Language of text to be displayed

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

TEXTFORMAT - Format of text to be displayed

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

LINKPATTERN - Convert SAPscript Hyperlinks to HTML

Data type: BAPITGA-LINKMASK
Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for BAPI_INTERFACE_GETDOCU

RETURN - Return Messages

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

TABLES Parameters details for BAPI_INTERFACE_GETDOCU

TEXT - Table for the text

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

Copy and paste ABAP code example for BAPI_INTERFACE_GETDOCU 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_text  TYPE STANDARD TABLE OF BAPITGB, "   
lv_return  TYPE BAPIRET2, "   
lv_objtype  TYPE BAPIF4A-OBJTYPE, "   
lv_objname  TYPE BAPIF4A-OBJNAME, "   
lv_method  TYPE BAPIF4A-METHOD, "   
lv_parameter  TYPE BAPIF4A-PARAM, "   
lv_field  TYPE BAPIF4A-FIELD, "   
lv_language  TYPE BAPITGA-LANGU, "   SY-LANGU
lv_textformat  TYPE BAPITGA-TEXTFORMAT, "   
lv_linkpattern  TYPE BAPITGA-LINKMASK. "   ' '

  CALL FUNCTION 'BAPI_INTERFACE_GETDOCU'  "Read BAPI Interface Documentation
    EXPORTING
         OBJTYPE = lv_objtype
         OBJNAME = lv_objname
         METHOD = lv_method
         PARAMETER = lv_parameter
         FIELD = lv_field
         LANGUAGE = lv_language
         TEXTFORMAT = lv_textformat
         LINKPATTERN = lv_linkpattern
    IMPORTING
         RETURN = lv_return
    TABLES
         TEXT = lt_text
. " BAPI_INTERFACE_GETDOCU




ABAP code using 7.40 inline data declarations to call FM BAPI_INTERFACE_GETDOCU

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 OBJTYPE FROM BAPIF4A INTO @DATA(ld_objtype).
 
"SELECT single OBJNAME FROM BAPIF4A INTO @DATA(ld_objname).
 
"SELECT single METHOD FROM BAPIF4A INTO @DATA(ld_method).
 
"SELECT single PARAM FROM BAPIF4A INTO @DATA(ld_parameter).
 
"SELECT single FIELD FROM BAPIF4A INTO @DATA(ld_field).
 
"SELECT single LANGU FROM BAPITGA INTO @DATA(ld_language).
DATA(ld_language) = SY-LANGU.
 
"SELECT single TEXTFORMAT FROM BAPITGA INTO @DATA(ld_textformat).
 
"SELECT single LINKMASK FROM BAPITGA INTO @DATA(ld_linkpattern).
DATA(ld_linkpattern) = ' '.
 


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!