DOC_OBJECT_GET SAP Function module - Documentation: Read text module (optional in RTF format)

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

Associated Function Group: SH01
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM DOC_OBJECT_GET - DOC OBJECT GET

CALL FUNCTION 'DOC_OBJECT_GET' "Documentation: Read text module (optional in RTF format)
  EXPORTING
    class =                     " dsysh-dokclass
    name =                      "
*   language = SY-LANGU         " sy-langu
*   short_text = SPACE          " sy-batch
*   appendix = SPACE            " sy-batch
*   iv_second_language = 'X'    " char1
  IMPORTING
    header =                    " thead
* TABLES
*   rtf_lines =                 " tline         Online help: RTF line structure
*   itf_lines =                 " tline
  EXCEPTIONS
    OBJECT_NOT_FOUND = 1        "
    .  "  DOC_OBJECT_GET

ABAP code example for Function Module DOC_OBJECT_GET

The ABAP code below is a full code listing to execute function module DOC_OBJECT_GET 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_header  
 
 TYPE THEAD
,
it_rtf_lines  
 
 TYPE STANDARD TABLE OF TLINE,"TABLES PARAM
wa_rtf_lines
 
 LIKE LINE OF it_rtf_lines
,
it_itf_lines  
 
 TYPE STANDARD TABLE OF TLINE,"TABLES PARAM
wa_itf_lines
 
 LIKE LINE OF it_itf_lines
.

 

SELECT single DOKCLASS 
  FROM DSYSH 
  INTO @DATA(ld_class).


DATA(ld_name) = 'some text here'.

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

DATA(ld_short_text) = 'some text here'.

DATA(ld_appendix) = 'some text here'.

DATA(ld_iv_second_language) = 'some text here'.
 

"populate fields of struture and append to itab
append wa_rtf_lines to it_rtf_lines.
 

"populate fields of struture and append to itab
append wa_itf_lines to it_itf_lines.
.

CALL FUNCTION 'DOC_OBJECT_GET'
  EXPORTING
    class =                      ld_class
    name =                       ld_name
*   language =                   ld_language
*   short_text =                 ld_short_text
*   appendix =                   ld_appendix
*   iv_second_language =         ld_iv_second_language
  IMPORTING
    header =                     ld_header
* TABLES
*   rtf_lines =                  it_rtf_lines
*   itf_lines =                  it_itf_lines
  EXCEPTIONS
    OBJECT_NOT_FOUND =           1
    .  "  DOC_OBJECT_GET

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "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_header
 
 TYPE THEAD ,
ld_class
 
 TYPE DSYSH-DOKCLASS ,
it_rtf_lines
 
 TYPE STANDARD TABLE OF TLINE ,
wa_rtf_lines
 
 LIKE LINE OF it_rtf_lines,
ld_name
 
 TYPE STRING ,
it_itf_lines
 
 TYPE STANDARD TABLE OF TLINE ,
wa_itf_lines
 
 LIKE LINE OF it_itf_lines,
ld_language
 
 TYPE SY-LANGU ,
ld_short_text
 
 TYPE SY-BATCH ,
ld_appendix
 
 TYPE SY-BATCH ,
ld_iv_second_language
 
 TYPE CHAR1 .



SELECT single DOKCLASS 
  FROM DSYSH 
  INTO ld_class.
 

"populate fields of struture and append to itab
append wa_rtf_lines to it_rtf_lines.
ld_name = 'some text here'. 

"populate fields of struture and append to itab
append wa_itf_lines to it_itf_lines.
ld_language = 'Check type of data required'.
ld_short_text = 'some text here'.
ld_appendix = 'some text here'.
ld_iv_second_language = 'some text here'.