SAP PRINT_TEXT Function Module for SAPscript: Print text









PRINT_TEXT is a standard print text 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: Print text 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 print text FM, simply by entering the name PRINT_TEXT into the relevant SAP transaction such as SE37 or SE38.

Function Group: STXD
Program Name: SAPLSTXD
Main Program: SAPLSTXD
Appliation area:
Release date: 16-Jan-1995
Mode(Normal, Remote etc): Normal Function Module
Update:



Function PRINT_TEXT 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 'PRINT_TEXT'"SAPscript: Print text
EXPORTING
* APPLICATION = 'TX' "Application code for interface
* ARCHIVE_INDEX = ' ' "Archive index
* ARCHIVE_PARAMS = ' ' "Archive Parameters
* DEVICE = 'PRINTER' "Device type
* DIALOG = 'X' "Indicator: Dialog for print options
HEADER = "Text header of text to be output
* OPTIONS = "Print Options

IMPORTING
NEW_ARCHIVE_PARAMS = "Archive parameters (return value)
RESULT = "Print options (return values)

TABLES
LINES = "Lines of text to be output
* OTFDATA = "OTF table (optional)

EXCEPTIONS
CANCELED = 1 BAD_PAGEFORMAT_FOR_PRINT = 10 DEVICE = 2 FORM = 3 OPTIONS = 4 UNCLOSED = 5 UNKNOWN = 6 FORMAT = 7 TEXTFORMAT = 8 COMMUNICATION = 9
.



IMPORTING Parameters details for PRINT_TEXT

APPLICATION - Application code for interface

Data type: TTXOB-TDAPPL
Default: 'TX'
Optional: Yes
Call by Reference: No ( called with pass by value option)

ARCHIVE_INDEX - Archive index

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

ARCHIVE_PARAMS - Archive Parameters

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

DEVICE - Device type

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

DIALOG - Indicator: Dialog for print options

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

HEADER - Text header of text to be output

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

OPTIONS - Print Options

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

EXPORTING Parameters details for PRINT_TEXT

NEW_ARCHIVE_PARAMS - Archive parameters (return value)

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

RESULT - Print options (return values)

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

TABLES Parameters details for PRINT_TEXT

LINES - Lines of text to be output

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

OTFDATA - OTF table (optional)

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

EXCEPTIONS details

CANCELED - Print dialog cancelled

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

BAD_PAGEFORMAT_FOR_PRINT -

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

DEVICE - Device type

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

FORM - Form does not exist

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

OPTIONS - Print Options

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

UNCLOSED - A form is still active

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

UNKNOWN - Error not specified

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

FORMAT - Incorrect page format

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

TEXTFORMAT - Text format cannot be processed

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

COMMUNICATION - Communication error

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

Copy and paste ABAP code example for PRINT_TEXT 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:
lt_lines  TYPE STANDARD TABLE OF TLINE, "   
lv_canceled  TYPE TLINE, "   
lv_application  TYPE TTXOB-TDAPPL, "   'TX'
lv_new_archive_params  TYPE ARC_PARAMS, "   
lv_bad_pageformat_for_print  TYPE ARC_PARAMS, "   
lv_device  TYPE ARC_PARAMS, "   
lv_result  TYPE ITCPP, "   
lt_otfdata  TYPE STANDARD TABLE OF ITCOO, "   
lv_archive_index  TYPE TOA_DARA, "   SPACE
lv_form  TYPE TOA_DARA, "   
lv_archive_params  TYPE ARC_PARAMS, "   SPACE
lv_device  TYPE ARC_PARAMS, "   'PRINTER'
lv_options  TYPE ARC_PARAMS, "   
lv_dialog  TYPE ARC_PARAMS, "   'X'
lv_unclosed  TYPE ARC_PARAMS, "   
lv_header  TYPE THEAD, "   
lv_unknown  TYPE THEAD, "   
lv_format  TYPE THEAD, "   
lv_options  TYPE ITCPO, "   
lv_textformat  TYPE ITCPO, "   
lv_communication  TYPE ITCPO. "   

  CALL FUNCTION 'PRINT_TEXT'  "SAPscript: Print text
    EXPORTING
         APPLICATION = lv_application
         ARCHIVE_INDEX = lv_archive_index
         ARCHIVE_PARAMS = lv_archive_params
         DEVICE = lv_device
         DIALOG = lv_dialog
         HEADER = lv_header
         OPTIONS = lv_options
    IMPORTING
         NEW_ARCHIVE_PARAMS = lv_new_archive_params
         RESULT = lv_result
    TABLES
         LINES = lt_lines
         OTFDATA = lt_otfdata
    EXCEPTIONS
        CANCELED = 1
        BAD_PAGEFORMAT_FOR_PRINT = 10
        DEVICE = 2
        FORM = 3
        OPTIONS = 4
        UNCLOSED = 5
        UNKNOWN = 6
        FORMAT = 7
        TEXTFORMAT = 8
        COMMUNICATION = 9
. " PRINT_TEXT




ABAP code using 7.40 inline data declarations to call FM PRINT_TEXT

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 TDAPPL FROM TTXOB INTO @DATA(ld_application).
DATA(ld_application) = 'TX'.
 
 
 
 
 
 
DATA(ld_archive_index) = ' '.
 
 
DATA(ld_archive_params) = ' '.
 
DATA(ld_device) = 'PRINTER'.
 
 
DATA(ld_dialog) = '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!