SAP ABAP Class CL_RSPO_SPOOL_HANDLE (Spool: Spool Request Opened for Writing)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-PRN (Application Component) Print and Output Management
⤷
SPOO (Package) Spool
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-CCM-PRN (Application Component) Print and Output Management⤷
SPOO (Package) SpoolProperties
| Class | CL_RSPO_SPOOL_HANDLE | |
| Short Description | Spool: Spool Request Opened for Writing | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SPOO | Spool |
| Created | 20000908 | SAP |
| Last change | 00000000 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  SPJT |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_RSPO_SPOOL_HANDLE has no interface implemented.
Friends
Class CL_RSPO_SPOOL_HANDLE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE |
Instance attribute | Private | Type reference (TYPE) | SY-TABIX | Internal Tables, Current Row Index | 20000908 | ||
| 2 | OPENED |
Instance attribute | Private | Type reference (TYPE) | FLAG | General Indicator | 20000908 | ||
| 3 | SPOOLID |
Instance attribute | Private | Type reference (TYPE) | TSP01-RQIDENT | Spool request number | 20000908 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_PARTS |
Instance method | Public | Method | Add Part Requests | 20000908 |
| 2 | CLOSE |
Instance method | Public | Method | Close a Spool Request | 20000908 |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20000908 |
| 4 | OPEN |
Static method | Public | Method | Open a Spool Request | 20000908 |
| 5 | WRITE |
Instance method | Public | Method | Write a List Line | 20000908 |
| 6 | WRITE_BINARY |
Instance method | Public | Method | Write a Byte Line | 20000908 |
| 7 | WRITE_OTF |
Instance method | Public | Method | Write an OTF Line | 20000908 |
| 8 | WRITE_PAGE_BREAK |
Instance method | Public | Method | Write a Page Break | 20000908 |
Events
Class CL_RSPO_SPOOL_HANDLE has no event.
Types
Class CL_RSPO_SPOOL_HANDLE has no local type.
Method Signatures
Method ADD_PARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
AUTO_TOC | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 2 |  Exporting |
PAGECOUNT | Call by reference | Type reference (TYPE) | I | 20000908 | |||
| 3 |  Changing |
PARTS | Call by reference | Type reference (TYPE) | SPJT_PARTS | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ILLEGAL_DEVICE_TYPE |
20000908 | ||
| 2 | INCOMPLETE |
20000908 | ||
| 3 | JOB_NOT_FINAL |
20000908 | ||
| 4 | NOT_OPEN |
20000908 | ||
| 5 | NO_COMP_JOB |
20000908 | ||
| 6 | NO_PERMISSION |
20000908 | ||
| 7 | NO_SUCH_DEVICE |
20000908 | ||
| 8 | NO_SUCH_PART |
20000908 |
Method CLOSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
FINAL | Call by reference | Type reference (TYPE) | FLAG | ' ' | Spoolauftrag abschließen | 20000908 | |
| 2 | Importing |
PAGES | Call by reference | Type reference (TYPE) | I | Seitenzahl explizit setzen | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ALREADY_CLOSED |
Schon geschlossen | 20000908 | |
| 2 | OPERATION_FAILED |
Operation fehlgeschlagen | 20000908 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ACTTIME | Value transfer | Type reference (TYPE) | TSP02-PJACTTIME | SysLog Zeitstempel | 20000908 | ||
| 2 | Importing |
APPEND | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 3 | Importing |
ARCHMODE | Value transfer | Type reference (TYPE) | TSP01-RQARCHTYPE | Archivierungstyp (nur intern, nicht auf Dynpro ) | 20000908 | ||
| 4 | Importing |
ARCHPARAMS | Value transfer | Type reference (TYPE) | ARC_PARAMS | ImageLink Struktur | 20000908 | ||
| 5 | Importing |
ATTRIBUTES | Value transfer | Type reference (TYPE) | SPJT_ATTRIBUTES | 20000908 | |||
| 6 | Importing |
AUTHORITY | Value transfer | Type reference (TYPE) | TSP01-RQAUTH | Wert für die Berechtigungsprüfung | 20000908 | ||
| 7 | Importing |
AUTO_DELETE | Value transfer | Type reference (TYPE) | TSP01-RQ2DISPO | Automatisches Löschen des Spool-Auftrags | 20000908 | ||
| 8 | Importing |
CODEPAGE | Value transfer | Type reference (TYPE) | TCP00-CPCODEPAGE | SAP-Zeichensatzidentifikation | 20000908 | ||
| 9 | Importing |
COPIES | Value transfer | Type reference (TYPE) | TSP01-RQCOPIES | Anzahl Ausdrucke | 20000908 | ||
| 10 | Importing |
COVERPAGE | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 11 | Importing |
DEST | Value transfer | Type reference (TYPE) | TSP01-RQDEST | Spool: Ausgabegerät | 20000908 | ||
| 12 | Importing |
DIVISION | Value transfer | Type reference (TYPE) | TSP01-RQDIVISION | Abteilungsbezeichnung | 20000908 | ||
| 13 | Importing |
DOCTYPE | Value transfer | Type reference (TYPE) | TSP01-RQDOCTYPE | Spool: Dokumenten-Typ | 20000908 | ||
| 14 | Importing |
IMMEDIATE_PRINT | Value transfer | Type reference (TYPE) | TSP01-RQ1DISPO | sofort oder spaeter drucken | 20000908 | ||
| 15 | Importing |
LAYOUT | Value transfer | Type reference (TYPE) | TSP01-RQPAPER | Spool: Aufbereitungsart | 20000908 | ||
| 16 | Importing |
LDEST | Value transfer | Type reference (TYPE) | TSP03D-NAME | Spool: lange Gerätenamen | 20000908 | ||
| 17 | Importing |
LIFETIME | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 18 | Importing |
NAME | Value transfer | Type reference (TYPE) | TSP01-RQ0NAME | Spool-Auftrag: Name | 20000908 | ||
| 19 | Importing |
POSNAME | Value transfer | Type reference (TYPE) | TSP01-RQPOSNAME | Spool: Langer Name von Druckern beim Host-Spooler | 20000908 | ||
| 20 | Importing |
PRIO | Value transfer | Type reference (TYPE) | TSP01-RQPRIO | Spool: Priorität eines Spool- oder Druckauftrags | 20000908 | ||
| 21 | Importing |
RECEIVER | Value transfer | Type reference (TYPE) | TSP01-RQRECEIVER | Spool: Empfänger eines Spool-Auftrages | 20000908 | ||
| 22 | Importing |
SUFFIX1 | Value transfer | Type reference (TYPE) | TSP01-RQ1NAME | Spool-Auftrag: Suffix1 | 20000908 | ||
| 23 | Importing |
SUFFIX2 | Value transfer | Type reference (TYPE) | TSP01-RQ2NAME | Spool-Auftrag: Suffix2 | 20000908 | ||
| 24 | Importing |
TELELAND | Value transfer | Type reference (TYPE) | TSP01-RQTELELAN | Länderschlüssel | 20000908 | ||
| 25 | Importing |
TELENUM | Value transfer | Type reference (TYPE) | TSP01-RQTELENUM | Telekommunikationspartner | 20000908 | ||
| 26 | Importing |
TELENUME | Value transfer | Type reference (TYPE) | TSP01-RQTELENUME | Telekommunikationspartner | 20000908 | ||
| 27 | Importing |
TITLELINE | Value transfer | Type reference (TYPE) | TSP01-RQTITLE | Titel eines Spool-Auftrages | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DEVICE_MISSING |
20000908 | ||
| 2 | NAME_TWICE |
20000908 | ||
| 3 | NO_SUCH_DEVICE |
20000908 | ||
| 4 | OPERATION_FAILED |
20000908 |
Method OPEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ACTTIME | Value transfer | Type reference (TYPE) | TSP02-PJACTTIME | SysLog Zeitstempel | 20000908 | ||
| 2 | Importing |
APPEND | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 3 | Importing |
ARCHMODE | Value transfer | Type reference (TYPE) | TSP01-RQARCHTYPE | Archivierungstyp (nur intern, nicht auf Dynpro ) | 20000908 | ||
| 4 | Importing |
ARCHPARAMS | Value transfer | Type reference (TYPE) | ARC_PARAMS | ImageLink Struktur | 20000908 | ||
| 5 | Importing |
ATTRIBUTES | Value transfer | Type reference (TYPE) | SPJT_ATTRIBUTES | 20000908 | |||
| 6 | Importing |
AUTHORITY | Value transfer | Type reference (TYPE) | TSP01-RQAUTH | Wert für die Berechtigungsprüfung | 20000908 | ||
| 7 | Importing |
AUTO_DELETE | Value transfer | Type reference (TYPE) | TSP01-RQ2DISPO | Automatisches Löschen des Spool-Auftrags | 20000908 | ||
| 8 | Importing |
CODEPAGE | Value transfer | Type reference (TYPE) | TCP00-CPCODEPAGE | SAP-Zeichensatzidentifikation | 20000908 | ||
| 9 | Importing |
COPIES | Value transfer | Type reference (TYPE) | TSP01-RQCOPIES | Anzahl Ausdrucke | 20000908 | ||
| 10 | Importing |
COVERPAGE | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 11 | Importing |
DEST | Value transfer | Type reference (TYPE) | TSP01-RQDEST | Spool: Ausgabegerät | 20000908 | ||
| 12 | Importing |
DIVISION | Value transfer | Type reference (TYPE) | TSP01-RQDIVISION | Abteilungsbezeichnung | 20000908 | ||
| 13 | Importing |
DOCTYPE | Value transfer | Type reference (TYPE) | TSP01-RQDOCTYPE | Spool: Dokumenten-Typ | 20000908 | ||
| 14 | Importing |
IMMEDIATE_PRINT | Value transfer | Type reference (TYPE) | TSP01-RQ1DISPO | sofort oder spaeter drucken | 20000908 | ||
| 15 | Importing |
LAYOUT | Value transfer | Type reference (TYPE) | TSP01-RQPAPER | Spool: Aufbereitungsart | 20000908 | ||
| 16 | Importing |
LDEST | Value transfer | Type reference (TYPE) | TSP03D-NAME | Spool: lange Gerätenamen | 20000908 | ||
| 17 | Importing |
LIFETIME | Value transfer | Type reference (TYPE) | C | '0' | 20000908 | ||
| 18 | Importing |
NAME | Value transfer | Type reference (TYPE) | TSP01-RQ0NAME | Spool-Auftrag: Name | 20000908 | ||
| 19 | Importing |
POSNAME | Value transfer | Type reference (TYPE) | TSP01-RQPOSNAME | Spool: Langer Name von Druckern beim Host-Spooler | 20000908 | ||
| 20 | Importing |
PRIO | Value transfer | Type reference (TYPE) | TSP01-RQPRIO | Spool: Priorität eines Spool- oder Druckauftrags | 20000908 | ||
| 21 | Importing |
RECEIVER | Value transfer | Type reference (TYPE) | TSP01-RQRECEIVER | Spool: Empfänger eines Spool-Auftrages | 20000908 | ||
| 22 | Exporting |
REF | Call by reference | Object reference (TYPE REF TO) | CL_RSPO_SPOOL_HANDLE | Spool: Zum Schreiben geöffneter Spoolauftrag | 20000908 | ||
| 23 | Exporting |
SPOOLID | Call by reference | Type reference (TYPE) | TSP01-RQIDENT | Spool: Spool-Auftragsnummer | 20000908 | ||
| 24 | Importing |
SUFFIX1 | Value transfer | Type reference (TYPE) | TSP01-RQ1NAME | Spool-Auftrag: Suffix1 | 20000908 | ||
| 25 | Importing |
SUFFIX2 | Value transfer | Type reference (TYPE) | TSP01-RQ2NAME | Spool-Auftrag: Suffix2 | 20000908 | ||
| 26 | Importing |
TELELAND | Value transfer | Type reference (TYPE) | TSP01-RQTELELAN | Länderschlüssel | 20000908 | ||
| 27 | Importing |
TELENUM | Value transfer | Type reference (TYPE) | TSP01-RQTELENUM | Telekommunikationspartner | 20000908 | ||
| 28 | Importing |
TELENUME | Value transfer | Type reference (TYPE) | TSP01-RQTELENUME | Telekommunikationspartner | 20000908 | ||
| 29 | Importing |
TITLELINE | Value transfer | Type reference (TYPE) | TSP01-RQTITLE | Titel eines Spool-Auftrages | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DEVICE_MISSING |
20000908 | ||
| 2 | NAME_TWICE |
20000908 | ||
| 3 | NO_SUCH_DEVICE |
20000908 | ||
| 4 | OPERATION_FAILED |
20000908 |
Method WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CODEPAGE | Value transfer | Type reference (TYPE) | TCP00-CPCODEPAGE | SAP-Zeichensatzidentifikation | 20000908 | ||
| 2 | Importing |
LENGTH | Value transfer | Type reference (TYPE) | I | 20000908 | |||
| 3 | Importing |
TEXT | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 4 | Importing |
TRUNCATE | Value transfer | Type reference (TYPE) | C | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_OPEN |
20000908 | ||
| 2 | OPERATION_FAILED |
20000908 |
Method WRITE_BINARY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CODEPAGE | Value transfer | Type reference (TYPE) | TCP00-CPCODEPAGE | SAP-Zeichensatzidentifikation | 20000908 | ||
| 2 | Importing |
DATA | Value transfer | Type reference (TYPE) | X | 20000908 | |||
| 3 | Importing |
LENGTH | Value transfer | Type reference (TYPE) | I | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_OPEN |
20000908 | ||
| 2 | OPERATION_FAILED |
20000908 |
Method WRITE_OTF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CMD | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 2 | Importing |
LENGTH | Value transfer | Type reference (TYPE) | I | 20000908 | |||
| 3 | Importing |
PARAM | Value transfer | Type reference (TYPE) | C | 20000908 | |||
| 4 | Importing |
TRUNCATE | Value transfer | Type reference (TYPE) | FLAG | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_OPEN |
20000908 | ||
| 2 | OPERATION_FAILED |
20000908 |
Method WRITE_PAGE_BREAK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LENGTH | Value transfer | Type reference (TYPE) | I | 20000908 | |||
| 2 | Importing |
OPTIONS | Value transfer | Type reference (TYPE) | C | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_OPEN |
20000908 | ||
| 2 | OPERATION_FAILED |
20000908 |
History
| Last changed by/on | SAP | 00000000 |
| SAP Release Created in | 50A |
