SAP READ_FORM Function Module for SAPscript: Read layout set









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

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



Function READ_FORM 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 'READ_FORM'"SAPscript: Read layout set
  EXPORTING
*  CLIENT = SY-MANDT "
   FORM =  "
*  LANGUAGE = SY-LANGU "
*  OLANGUAGE = ' ' "
*  OSTATUS = ' ' "
*  STATUS = ' ' "
*  THROUGHCLIENT = ' ' "
*  READ_ONLY_HEADER = ' ' "
*  THROUGHLANGUAGE = ' ' "

 IMPORTING
   FORM_HEADER =  "
   FOUND =  "
   HEADER =  "
   OLANGUAGE =  "

TABLES
*  FORM_LINES =  "
*  PAGES =  "
*  PAGE_WINDOWS =  "
*  PARAGRAPHS =  "
*  STRINGS =  "
*  TABS =  "
*  WINDOWS =  "
.



IMPORTING Parameters details for READ_FORM

CLIENT -

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

FORM -

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

LANGUAGE -

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

OLANGUAGE -

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

OSTATUS -

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

STATUS -

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

THROUGHCLIENT -

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

READ_ONLY_HEADER -

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

THROUGHLANGUAGE -

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

EXPORTING Parameters details for READ_FORM

FORM_HEADER -

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

FOUND -

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

HEADER -

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

OLANGUAGE -

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

TABLES Parameters details for READ_FORM

FORM_LINES -

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

PAGES -

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

PAGE_WINDOWS -

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

PARAGRAPHS -

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

STRINGS -

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

TABS -

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

WINDOWS -

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

Copy and paste ABAP code example for READ_FORM 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_client  TYPE SY-MANDT, "   SY-MANDT
lt_form_lines  TYPE STANDARD TABLE OF TLINE, "   
lv_form_header  TYPE ITCTA, "   
lv_form  TYPE ITCTA-TDFORM, "   
lv_found  TYPE ITCTA, "   
lt_pages  TYPE STANDARD TABLE OF ITCTG, "   
lv_header  TYPE THEAD, "   
lv_language  TYPE SY-LANGU, "   SY-LANGU
lt_page_windows  TYPE STANDARD TABLE OF ITCTH, "   
lv_olanguage  TYPE SY-LANGU, "   
lv_olanguage  TYPE SY-LANGU, "   SPACE
lt_paragraphs  TYPE STANDARD TABLE OF ITCDP, "   
lv_ostatus  TYPE ITCTA-TDSTATUS, "   SPACE
lt_strings  TYPE STANDARD TABLE OF ITCDS, "   
lt_tabs  TYPE STANDARD TABLE OF ITCDQ, "   
lv_status  TYPE ITCTA-TDSTATUS, "   SPACE
lt_windows  TYPE STANDARD TABLE OF ITCTW, "   
lv_throughclient  TYPE ITCTW, "   SPACE
lv_read_only_header  TYPE C, "   SPACE
lv_throughlanguage  TYPE C. "   SPACE

  CALL FUNCTION 'READ_FORM'  "SAPscript: Read layout set
    EXPORTING
         CLIENT = lv_client
         FORM = lv_form
         LANGUAGE = lv_language
         OLANGUAGE = lv_olanguage
         OSTATUS = lv_ostatus
         STATUS = lv_status
         THROUGHCLIENT = lv_throughclient
         READ_ONLY_HEADER = lv_read_only_header
         THROUGHLANGUAGE = lv_throughlanguage
    IMPORTING
         FORM_HEADER = lv_form_header
         FOUND = lv_found
         HEADER = lv_header
         OLANGUAGE = lv_olanguage
    TABLES
         FORM_LINES = lt_form_lines
         PAGES = lt_pages
         PAGE_WINDOWS = lt_page_windows
         PARAGRAPHS = lt_paragraphs
         STRINGS = lt_strings
         TABS = lt_tabs
         WINDOWS = lt_windows
. " READ_FORM




ABAP code using 7.40 inline data declarations to call FM READ_FORM

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 MANDT FROM SY INTO @DATA(ld_client).
DATA(ld_client) = SY-MANDT.
 
 
 
"SELECT single TDFORM FROM ITCTA INTO @DATA(ld_form).
 
 
 
 
"SELECT single LANGU FROM SY INTO @DATA(ld_language).
DATA(ld_language) = SY-LANGU.
 
 
"SELECT single LANGU FROM SY INTO @DATA(ld_olanguage).
 
"SELECT single LANGU FROM SY INTO @DATA(ld_olanguage).
DATA(ld_olanguage) = ' '.
 
 
"SELECT single TDSTATUS FROM ITCTA INTO @DATA(ld_ostatus).
DATA(ld_ostatus) = ' '.
 
 
 
"SELECT single TDSTATUS FROM ITCTA INTO @DATA(ld_status).
DATA(ld_status) = ' '.
 
 
DATA(ld_throughclient) = ' '.
 
DATA(ld_read_only_header) = ' '.
 
DATA(ld_throughlanguage) = ' '.
 


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!