Return Parameters of the Print Output
After formatting SAPscript texts for printing, the parameter RESULT contains information and settings which can be of interest for the calling program. This information can be passed using the function modules PRINT_TEXT or CLOSE_FORM. The parameter reference structure is ITCPP.
The structure includes fields, which have previously been passed in the parameter OPTIONS when calling the output function module, and other information, which the system can supply only after completing the formatting request.
Differences between the values in the parameter OPTIONS and the corresponding fields in the parameter RESULT tell the application program that the user changed the default values displayed in the print selection screen.
TDPAGESLCT |
SAPscript: select print page |
TDNOPREV |
SAPscript: disable print view |
TDPREVIEW |
SAPscript: print view |
TDNOPRINT |
SAPscript: disable print function from within print view |
TDTITLE |
SAPscript: text for title line in the print selection screen |
TDPROGRAM |
SAPscript: program name for replacing symbols |
TDTEST |
SAPscript: test printout |
TDIEXIT |
SAPscript: return immediately after printing |
TDGETOTF |
SAPscript: return OTF table; no print output |
TDSCRNPOS |
SAPscript: display position for OTF on the screen |
TDAPPL |
SAPscript: interface of the print view |
TDOTFCALL |
SAPscript: name of the driver module |
TDOTFTYPE |
SAPscript: OTF type |
TDPAGES |
SAPscript: number of printed pages |
TDFORMS |
SAPscript: number of used forms |
TDWARNINGS |
SAPscript: number of warnings during print formatting |
TDDEVICE |
SAPscript: type of output device |
TDSCREEN |
SAPscript: type of screen display |
TDSCDRIVER |
SAPscript: type of screen driver |
TDSCABAP |
SAPscript: ABAP list as print view |
USEREXIT |
SAPscript: last executed user function |
TDRTL |
SAPscript: right-to-left language in OTF |
TDDEST |
Spool: name of the output device |
TDPRINTER |
Spool: name of device type |
TDCOPIES |
Spool: number of copies |
TDNEWID |
Spool: new request |
TDIMMED |
Spool: print request immediately |
TDDELETE |
Spool: delete request after printing |
TDLIFETIME |
Spool: retention time of the request |
TDDATASET |
Spool: identification of the request |
TDSUFFIX1 |
Spool: suffix 1 of the request |
TDSUFFIX2 |
Spool: suffix 2 of the request |
TDAUTORITY |
Spool: authorization for a request |
TDARMOD |
Spool: archiving mode |
TDCOVER |
Spool: print cover page |
TDCOVTITLE |
Spool: cover page: title text |
TDRECEIVER |
Spool: cover page: recipient name |
TDDIVISION |
Spool: cover page: division name |
TDSPOOLID |
Spool: number of the request |
TDDRIVER |
Spool: name of a driver |
TDABAP |
Spool: driver type |
TDPAGEFORM |
Spool: page format of the spool request |
TDSCHEDULE |
SAPcomm: type of scheduled send time |
TDSENDDATE |
SAPcomm: requested send date |
TDSENDTIME |
SAPcomm: requested send time |
TDTELELAND |
SAPcomm: country key of recipient country |
TDTELENUM |
SAPcomm: number of telecommunications partner |
TDTELENUME |
SAPcomm: dialed number of telecommunications partner |
TDPAGESLCT: SAPscript: select print pages
The field contains the pages to be printed. The value either comes from user entries on the print selection screen or from the corresponding field passed in the OPTIONS parameter.
TDNOPREV: SAPscript: print view
Describes whether the user was able to call the print view from the print selection screen.
Possible values:
'X' |
print view was disabled |
' ' |
print view was enabled |
TDPREVIEW: SAPscript: display print view
The print program uses this field to determine whether the user actually called the print view from the print selection screen.
Possible values:
'X' |
user called print view |
' ' |
print view was not called |
TDNOPRINT: SAPscript: disable print function from print view
Describes whether the user was able to print the SAPscript text from within the print view.
Possible values:
'X' |
print function enabled on print view display |
' ' |
print function disabled on print view display |
TDTITLE: SAPscript: title on print selection screen
The field contains the text, which was displayed in the title line of the print selection screen.
TDPROGRAM: SAPscript: program name for replacing symbols
The field returns the name of the program that was specified in the corresponding field of the OPTIONS parameter when calling the print function. This program is the default value for work areas from which the system replaced the program symbols with the current values.
TDTEST: SAPscript: test printout
Indicates whether the user used the print function in test mode.
Possible values:
'X' |
formatting in test mode |
' ' |
normal print formatting |
TDIEXIT: SAPscript: return after printing
The field indicates whether after printing from within the print view, the system immediately returned to the application program.
Possible values:
'X' |
print view left immediately after printing |
' ' |
remained in print view after printing |
TDGETOTF: SAPscript: return of OTF table; no print output
The field indicates whether the SAPscript formatting program passed the print output (OTF) to the print view or spool or whether it returned the output to the calling program using table OTFDATA.
Possible values:
'X' |
print output returned in table OTFDATA |
' ' |
print output passed to print view or spool |
TDSCRNPOS: SAPscript: display position for OTF on the screen
The field returns the display position on the screen, which was specified in the call in the corresponding field of the OPTIONS parameter.
TDAPPL: SAPscript: interface of the print view
The field returns the abbreviation of the interface name used for the print view. The abbreviation corresponds to the editor interface name you can specify for a word processing application object in table TTXOB. The contents corresponds to the value passed in the parameter APPLICATION when calling the function modules OPEN_FORM or PRINT_TEXT.
TDOTFCALL: SAPscript: name of driver function module
The field contains the name of the ABAP function module used as driver to convert the OTF format into the device-specific control sequences. This field is filled only if in table TSP09 an entry for the current output device specifies that the system shall use an ABAP function module as driver.
Usually, this field is empty, since in recent releases the output drivers are C functions.
TDOTFTYPE: SAPscript: driver type for OTF output
This field specifies the type of the OTF driver used to print a SAPscript document. The format SAPscript creates after formatting a text for outputting is called OTF format (Output Text Format). This format is independent of the output device and must therefore be converted before outputting the text on a certain device (screen, printer type). During this conversion, the system, that is, the SAPscript drivers, replace the OTF commands with device-specific control sequences. The names of the drivers are defined in table TSP09. Table TSP0A is used to allocate a driver to each device type (including printers, screens, telefaxes, and so on). This driver then formats SAPscript texts for this device.
At present, the following OTF drivers exist:
TDPAGES: SAPscript: number of printed pages
This field specifies the number of physical pages created for screen display or print output. This number includes all copies, even though they are created only by the spool system and cannot be seen in the print view. A cover page is not included into the number stored in TDPAGES.
TDFORMS: SAPscript: number of used forms
The contents of this field indicates how many forms were started during SAPscript formatting. If you called the function module PRINT_TEXT for printing, this field always contains 1. If you used explicit form control, the system counts all forms called using the function module START_FORM within a OPEN_FORM / CLOSE_FORM chain.
TDWARNINGS: SAPscript: warnings during formatting
This field contains the number of warnings that occurred during print formatting. Warnings in SAPscript do not end the print formatting process. Depending on the type of warning, the system either ignores the cause or uses default values.
Possible warnings are:
TDDEVICE: SAPscript: type of output device
The field returns the type of the output device used. Its contents corresponds to the value of the parameters DEVICE, which you can specify when calling the function modules PRINT_TEXT and OPEN_FORM
Possible values:
'PRINTER' |
Formatting for the specified printer |
'TELEX' |
Formatting for telex output |
'TELEFAX' |
Formatting for telefax output |
'SCREEN' |
Formatting for screen output as ABAP list. The parameter APPLICATION determines the interface. |
'ABAP' |
Formatting for screen output as ABAP list. The calling program controls the interface. |
'OTF_MEM' |
The OTF format created by SAPscript is stored in the text memory. Formatting as for SCREEN |
TDSCREEN: SAPscript: type of screen display
Returns the type of screen display. The value ‘SCREEN’ is returned only if in DEVICE, formatting for screen output is specified. All other values refer to the value ‘PRINTER’ of the field DEVICE and appear only if the user selected the print view as screen display.
Possible values:
' ' |
no screen display |
'SCREEN' |
formatting for screen as ABAP list |
'MF' |
print view display for Motif |
'PM' |
print view display for OS/2 |
'WN' |
print view display for Windows |
'WN32' |
print view display for Windows NT |
TDSCDRIVER: SAPscript: type of screen driver
Returns the type of the driver used to create the screen display of the print view.
Possible values:
' ' |
no screen display |
'LIST' |
ABAP list |
'MF' |
print view for Motif |
'PM' |
print view for OS/2 |
'WN' |
print view for Windows |
'WN32' |
Print view for Windows NT |
TDSCABAP: SAPscript: ABAP list as print view
The field indicates whether the SAPscript print view was represented as ABAP list.
Possible values:
'X' |
ABAP list |
' ' |
no ABAP list |
USEREXIT: SAPscript: last executed user action
The field indicates the function the user chose to leave the print selection screen.
Possible values:
'C' |
user chose function Cancel |
'B' |
user chose function Back |
'E' |
user chose function Exit |
TDRTL: SAPscript: right-to-left language in OTF
The field indicates whether the print output contains text lines in a language whose characters are output from right to left (fro example, Hebrew).
Possible values:
'X' |
right-to-left language |
' ' |
no right-to-left language |
TDDEST: Spool: name of output device
The field contains the name of the output device for which the system formatted the output.
TDPRINTER: Spool: name of device type
The field contains the type of the device specified in TDDEST.
TDCOPIES: Spool: number of copies
The field indicates how often the output was printed.
The user can set the contents of this field on the print selection screen.
TDNEWID: Spool: new request
Tells the print program whether to append the output to an existing request or whether to create a new request anyway.
The user can set this option on the print selection screen.
Possible values:
'X' |
new spool request |
' ' |
append to existing spool request |
TDIMMED: Spool: print request immediately
The field indicates whether the request was printed immediately after completion or whether it was kept in the spool until the user or the program explicitly triggered print output.
The user can set this option on the print selection screen.
Possible values:
'X' |
request printed immediately |
' ' |
request kept in spool |
TDDELETE: Spool: delete request after printing
Indicates whether the spool request shall be deleted after printing.
The user can set this option on the print selection screen.
Possible values:
'X' |
delete request after printing |
' ' |
keep request |
TDLIFETIME: Spool: retention period of the request
The value corresponds to the number of days for which the request is kept in the spool.
The user can set this option on the print selection screen.
TDDATASET: Spool: name of the request
Returns the first part of the three-part identification of the spool request.
The user can set this option on the print selection screen.
TDSUFFIX1: Spool: suffix 1 of the request
Returns the second part of the three-part identification of the spool request.
The user can set this option on the print selection screen.
TDSUFFIX2: Spool: suffix 2 of the request
Returns the third part of the three-part identification of the request.
The user can set this option on the print selection screen.
TDARMOD: Spool: archiving mode
The print program uses this field to determine the archiving mode the user set on the print selection screen.
Possible values:
'1' |
request printed (default) |
'2' |
request archived |
'3' |
request printed and archived |
TDCOVER: Spool: print cover page
Indicates whether a cover page was printed.
The user can set this option on the print selection screen.
Possible values:
'X' |
cover page printed |
' ' |
no cover page printed |
'D' |
cover page printed according to the default setting of the output device (see definition of the device in the spool administration, transaction SPAD, column output device). |
TDCOVTITLE: Spool: cover page: title text
Contains the title text for the cover page
The user can enter the title text on the print selection screen.
TDRECEIVER: Spool: cover page: recipient name
Contains the recipient name for the cover page of the print request, which the user entered on the print selection screen.
TDDIVISION: Spool: cover page: division name
Contains the division name for the cover page of the print request, which the user entered on the print selection screen.
TDAUTORITY: Spool: print authorization
The field specifies the authorization a user must have to display the print request in the spool.
The user can set this option on the print selection screen.
The spool print control (transaction SP01) checks whether a user has this value stored in the authorization object S_SPO_ACT (spool actions).
TDSPOOLID: Spool: number of the request
The field returns the number of the spool request into which the system placed the print output. The spool system assigns this number. If the value is > 0, the print program knows, that the system actually printed the request.
TDDRIVER: Spool: name of the driver
Contains the name of the driver that converted the SAPscript output format OTF into the final printer control sequences.
TDABAP: Spool: driver type
Returns the type of the SAPscript printer driver used for output.
Possible values:
'X' |
printer driver in ABAP |
' ' |
printer driver in C |
TDPAGEFORM: Spool: page format of the request
The field describes the page format of the print request. The page format is determined by the forms called in the current print request. One print request can contain only output with the same page format.
The possible page formats are described in table TSP08, which you can display using the spool administration (transaction SPAD, page formats).
TDSCHEDULE: SAPcomm: type of scheduled send time
Returns the type of send time of a print request sent via the SAP communication interface.
Possible values:
'IMM' |
send request immediately |
'NIG' |
send request during the night |
TDSENDDATE: SAPcomm: requested send date
The field contains the date on which the request shall be sent via the SAP communication interface.
TDSENDTIME: SAPcomm: requested send time
The field contains the time at which the request shall be sent via the SAP communication interface.
TDTELELAND: SAPcomm: country key
Specifies the country key of the desired telecommunications partner. According to this key, the system includes other country-specific information into the telephone number of the telecommunications partner.
TDTELENUM: SAPcomm: number of the telecommunications partner
Contains the originally specified number of the telecommunications partner.
TDTELENUME: SAPcomm: dialed number of the telecommunications partner
This field contains the complete telephone number of the telecommunications partner in the form in which the SAP communication interface constructed it according to the specified country key.