REFER_TEXT SAP Function module - SAPscript: Refer to text

REFER_TEXT 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 REFER_TEXT into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: STXD
Released Date: 16.01.1995
Processing type: Normal fucntion module

Pattern for FM REFER_TEXT - REFER TEXT

CALL FUNCTION 'REFER_TEXT' "SAPscript: Refer to text
  EXPORTING
*   check_reference = 'X'       "               Flag: Execute reference check
    header =                    " thead         Text header of referencing text
*   read_lines = 'X'            "               Flag: Read reference lines
    ref_id =                    " thead-tdid    Text ID of text to be referenced
    ref_name =                  " thead-tdname  Text name of text to be referenced
    ref_object =                " thead-tdobject  Text object of text to be referenced
  IMPORTING
    newheader =                 " thead         Text header of referencing text (changed)
  TABLES
    lines =                     " tline         Lines of referencing text
  EXCEPTIONS
    NOT_FOUND = 1               "               Reference text not available
    REFERENCE_CHECK = 2         "               Reference chain interrupted
    .  "  REFER_TEXT

ABAP code example for Function Module REFER_TEXT

The ABAP code below is a full code listing to execute function module REFER_TEXT 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:
ld_newheader  
 
 TYPE THEAD
,
it_lines  
 
 TYPE STANDARD TABLE OF TLINE,"TABLES PARAM
wa_lines
 
 LIKE LINE OF it_lines
.


DATA(ld_check_reference) = 'some text here'.

DATA(ld_header) = 'Check type of data required'.

DATA(ld_read_lines) = 'some text here'.


DATA(ld_ref_id) = some text here


DATA(ld_ref_name) = some text here


DATA(ld_ref_object) = some text here
 

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

CALL FUNCTION 'REFER_TEXT'
  EXPORTING
*   check_reference =            ld_check_reference
    header =                     ld_header
*   read_lines =                 ld_read_lines
    ref_id =                     ld_ref_id
    ref_name =                   ld_ref_name
    ref_object =                 ld_ref_object
  IMPORTING
    newheader =                  ld_newheader
  TABLES
    lines =                      it_lines
  EXCEPTIONS
    NOT_FOUND =                  1
    REFERENCE_CHECK =            2
    .  "  REFER_TEXT

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "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_newheader
 
 TYPE THEAD ,
ld_check_reference
 
 TYPE STRING ,
it_lines
 
 TYPE STANDARD TABLE OF TLINE ,
wa_lines
 
 LIKE LINE OF it_lines,
ld_header
 
 TYPE THEAD ,
ld_read_lines
 
 TYPE STRING ,
ld_ref_id
 
 TYPE THEAD-TDID ,
ld_ref_name
 
 TYPE THEAD-TDNAME ,
ld_ref_object
 
 TYPE THEAD-TDOBJECT .


ld_check_reference = 'some text here'. 

"populate fields of struture and append to itab
append wa_lines to it_lines.
ld_header = 'Check type of data required'.
ld_read_lines = 'some text here'.

ld_ref_id = some text here

ld_ref_name = some text here

ld_ref_object = some text here

SAP Documentation for FM REFER_TEXT