SAP SAP_WAPI_READ_CONTAINER Function Module for Workflow Interfaces: Read Container









SAP_WAPI_READ_CONTAINER is a standard sap wapi read container SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Workflow Interfaces: Read Container 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 sap wapi read container FM, simply by entering the name SAP_WAPI_READ_CONTAINER into the relevant SAP transaction such as SE37 or SE38.

Function Group: SWRR
Program Name: SAPLSWRR
Main Program: SAPLSWRR
Appliation area: S
Release date: 05-Aug-1999
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function SAP_WAPI_READ_CONTAINER 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 'SAP_WAPI_READ_CONTAINER'"Workflow Interfaces: Read Container
EXPORTING
WORKITEM_ID = "Work Item ID
* LANGUAGE = SY-LANGU "SAP System, Current Language
* USER = SY-UNAME "ABAP System, User Logon Name
* BUFFERED_ACCESS = 'X' "Determine Data from Buffer

IMPORTING
RETURN_CODE = "Return Value (0 - 1)
IFS_XML_CONTAINER = "Container Data in XML Representation
IFS_XML_CONTAINER_SCHEMA = "Container Data in XML Schema

TABLES
* SIMPLE_CONTAINER = "Single Container (Name-Value-Pair)
* MESSAGE_LINES = "Message Lines
* MESSAGE_STRUCT = "Message Structure
* SUBCONTAINER_BOR_OBJECTS = "BOR References in the Container
* SUBCONTAINER_ALL_OBJECTS = "All Object References in the Container
.



IMPORTING Parameters details for SAP_WAPI_READ_CONTAINER

WORKITEM_ID - Work Item ID

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

LANGUAGE - SAP System, Current Language

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

USER - ABAP System, User Logon Name

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

BUFFERED_ACCESS - Determine Data from Buffer

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

EXPORTING Parameters details for SAP_WAPI_READ_CONTAINER

RETURN_CODE - Return Value (0 - 1)

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

IFS_XML_CONTAINER - Container Data in XML Representation

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

IFS_XML_CONTAINER_SCHEMA - Container Data in XML Schema

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

TABLES Parameters details for SAP_WAPI_READ_CONTAINER

SIMPLE_CONTAINER - Single Container (Name-Value-Pair)

Data type: SWR_CONT
Optional: Yes
Call by Reference: Yes

MESSAGE_LINES - Message Lines

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

MESSAGE_STRUCT - Message Structure

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

SUBCONTAINER_BOR_OBJECTS - BOR References in the Container

Data type: SWR_CONT
Optional: Yes
Call by Reference: Yes

SUBCONTAINER_ALL_OBJECTS - All Object References in the Container

Data type: SWR_CONT
Optional: Yes
Call by Reference: Yes

Copy and paste ABAP code example for SAP_WAPI_READ_CONTAINER 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_return_code  TYPE SY-SUBRC, "   
lv_workitem_id  TYPE SWR_STRUCT-WORKITEMID, "   
lt_simple_container  TYPE STANDARD TABLE OF SWR_CONT, "   
lv_language  TYPE SYLANGU, "   SY-LANGU
lt_message_lines  TYPE STANDARD TABLE OF SWR_MESSAG, "   
lv_ifs_xml_container  TYPE XSTRING, "   
lv_user  TYPE SYUNAME, "   SY-UNAME
lt_message_struct  TYPE STANDARD TABLE OF SWR_MSTRUC, "   
lv_ifs_xml_container_schema  TYPE XSTRING, "   
lv_buffered_access  TYPE XFELD, "   'X'
lt_subcontainer_bor_objects  TYPE STANDARD TABLE OF SWR_CONT, "   
lt_subcontainer_all_objects  TYPE STANDARD TABLE OF SWR_CONT. "   

  CALL FUNCTION 'SAP_WAPI_READ_CONTAINER'  "Workflow Interfaces: Read Container
    EXPORTING
         WORKITEM_ID = lv_workitem_id
         LANGUAGE = lv_language
         USER = lv_user
         BUFFERED_ACCESS = lv_buffered_access
    IMPORTING
         RETURN_CODE = lv_return_code
         IFS_XML_CONTAINER = lv_ifs_xml_container
         IFS_XML_CONTAINER_SCHEMA = lv_ifs_xml_container_schema
    TABLES
         SIMPLE_CONTAINER = lt_simple_container
         MESSAGE_LINES = lt_message_lines
         MESSAGE_STRUCT = lt_message_struct
         SUBCONTAINER_BOR_OBJECTS = lt_subcontainer_bor_objects
         SUBCONTAINER_ALL_OBJECTS = lt_subcontainer_all_objects
. " SAP_WAPI_READ_CONTAINER




ABAP code using 7.40 inline data declarations to call FM SAP_WAPI_READ_CONTAINER

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 SUBRC FROM SY INTO @DATA(ld_return_code).
 
"SELECT single WORKITEMID FROM SWR_STRUCT INTO @DATA(ld_workitem_id).
 
 
DATA(ld_language) = SY-LANGU.
 
 
 
DATA(ld_user) = SY-UNAME.
 
 
 
DATA(ld_buffered_access) = 'X'.
 
 
 


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!