READ_FORM_LINES SAP Function module - Form creation: Read contents of a text element

READ_FORM_LINES is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name READ_FORM_LINES into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: STXC
Released Date: 20.01.1995
Processing type: Normal fucntion module

Pattern for FM READ_FORM_LINES - READ FORM LINES

CALL FUNCTION 'READ_FORM_LINES' "Form creation: Read contents of a text element
* EXPORTING
*   element = SPACE             "               Text element
*   element = SPACE             "               Text element does not exist
*   form = SPACE                "               Form
*   form = SPACE                "               Form does not exist
*   language = SPACE            "               Language
*   window = 'MAIN'             "               Window
  TABLES
    lines =                     " tline         Text lines of text element
  EXCEPTIONS
    ELEMENT = 1                 "               Text element does not exist
    ELEMENT = 1                 "               Text element
    FORM = 2                    "               Form does not exist
    FORM = 2                    "               Form
    UNOPENED = 3                "               Form output has not been opened
    .  "  READ_FORM_LINES

ABAP code example for Function Module READ_FORM_LINES

The ABAP code below is a full code listing to execute function module READ_FORM_LINES including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
it_lines  
 
 TYPE STANDARD TABLE OF TLINE,"TABLES PARAM
wa_lines
 
 LIKE LINE OF it_lines
.


DATA(ld_element) = 'some text here'.

DATA(ld_element) = 'some text here'.

DATA(ld_form) = 'some text here'.

DATA(ld_form) = 'some text here'.

DATA(ld_language) = 'some text here'.

DATA(ld_window) = 'some text here'.
 

"populate fields of struture and append to itab
append wa_lines to it_lines.
.

CALL FUNCTION 'READ_FORM_LINES'
* EXPORTING
*   element =                    ld_element
*   element =                    ld_element
*   form =                       ld_form
*   form =                       ld_form
*   language =                   ld_language
*   window =                     ld_window
  TABLES
    lines =                      it_lines
  EXCEPTIONS
    ELEMENT =                    1
    ELEMENT =                    1
    FORM =                       2
    FORM =                       2
    UNOPENED =                   3
    .  "  READ_FORM_LINES

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_element
 
 TYPE STRING ,
ld_element
 
 TYPE STRING ,
it_lines
 
 TYPE STANDARD TABLE OF TLINE ,
wa_lines
 
 LIKE LINE OF it_lines,
ld_form
 
 TYPE STRING ,
ld_form
 
 TYPE STRING ,
ld_language
 
 TYPE STRING ,
ld_window
 
 TYPE STRING .


ld_element = 'some text here'.
ld_element = 'some text here'. 

"populate fields of struture and append to itab
append wa_lines to it_lines.
ld_form = 'some text here'.
ld_form = 'some text here'.
ld_language = 'some text here'.
ld_window = 'some text here'.

SAP Documentation for FM READ_FORM_LINES