Ansicht
Dokumentation

GET_PRINT_PARAMETERS - Spool Druckparameter und Archivparameter lesen, bestimmen, ändern

CL_GUI_FRONTEND_SERVICES - Frontend Services BAL Application Log Documentation
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Der Funktionsbaustein GET_PRINT_PARAMETERS dient zum Bestimmen, Ändern und Anzeigen der Druck- und Archivierungsparameter. Die Verwendung des Funktionsbaustein ist die einzige korrekte Methode einen Druck- oder Archivierungsparametersatz zu verändern. Die Druckparameter gehören eng zusammen und enthalten eine Prüfsumme. Durch direkte Änderung einzelner Druckparameter wird diese Prüfsumme ungültig, was bei einer nachfolgenden Verwendung der Druckparameter zu einem Laufzeitfehler führt.

Die Vorgabeparameter werden über die Struktur IN_PARAMETERS bzw. IN_ARCHIVE_PARAMETERS angegeben. Diese Eingabeparameter müssen von einem anderen Aufruf von GET_PRINT_PARAMETERS stammen oder müssen initial sein. Die resultierenden Druck- und Archivierungsparameter werden über die Funktionsparameter OUT_PARAMETERS bzw. OUT_ARCHIVE_PARAMETERS zurückgeliefert. Mit den restlichen IMPORT-Parametern, wie DESTINATION, LIST_NAME usw. werden die Werte angegeben, die nach OUT_PARAMETERS bzw. OUT_ARCHIVE_PARAMETERS übernommen werden sollen. Der Ausgabeparameter VALID wird bei den interaktiven Aufrufen mit BLANK gefüllt, falls die Interaktion mit dem Druckdynpro vom Benutzer abgebrochen wurde.

Der Funktionsbaustein kann im Dialog (Parameter NO_DIALOG = SPACE) oder ohne Dialog ausgeführt werden. Falls er im Dialog ausgeführt wird, so erscheint eine Bildschirmmaske, in welcher die Druckparameter editiert werden können.
Hinweis: Die Angabe "Drucken von Seite bis Seite" in der Bildschirmmaske ist nicht dazu geeignet, von ABAP-Programmen verwendet zu werden und ist daher nicht Teil der Struktur PRI_PARAMS.

Der Baustein kennt folgende Modi (Werte des Parameters MODE):

PARAMS

Normalfall, Bestimmen der Druckparameter für das aktuelle Programm. Die nicht angegebenen Werte werden aus dem Benutzerstammsatz bzw. mit Defaultwerten versorgt. Auf dem Druckparameterbild wird die Taste DRUCKEN angeboten. Dieser Modus wird verwendet, wenn der Parameter MODE nicht angegeben wird.

PARAMSEL

Wie 'PARAMS', mit dem Unterschied, daß auf dem Druckparameterbild eine Möglichkeit zum Aktivieren des Selektionsdeckblatts besteht.

BATCH

Bestimmen der Druckparameter für einen Hintergrund-Job. In diesem Modus sollte über den Parameter REPORT der Name des zu startenden Reports übergeben werden. Die Reportanweisung des angegebenen Reports wird auf LINE-SIZE- und LINE-COUNT- Angaben hin untersucht. Diese Angaben werden als Default-Angaben übernommem. Außerdem wird in diesem Modus statt der Taste DRUCKEN die Taste SICHERN angeboten.

CURRENT

Bestimmen der aktuell geltenden Druckparameter: Diese Parameter ergeben sich aus folgenden Quellen:

Aus den Benutzerfestwerten für das Drucken
Falls der Report im Hintergrund läuft oder mit Ausführen&Drucken gestartet wurde, aus den dem Report übergebenen Druckparametern

Ansonsten ist das Verhalten wie bei PARAMSEL.

Generell sollte in diesem Modus der Importparameter NO_DIALOG gesetzt sein, da dieser Modus nur Sinn macht, falls er dunkel abgespielt wird.

DEFVALS

Ausgabe der Defaultwerte. Die Defaultwerte sind zum einen in den Benutzerfestwerten hinterlegt, zum anderen können sie über System-Liste-Drucken-"benutzerspez. Druckparameter" benutzer- und reportabhängig gepflegt werden. Es werden die Werte für den aktuellen Benutzer und Report zurückgeliefert.

DISPLAY

Anzeigen der übergebenen Druckparameter

Wichtig !!

Im Modus DEFVALS sind im Rückgabeparameter out_parameters Felder, die nicht in den Benutzerfestwerten gefunden werden, initial (Typ unknown).
Das heißt, wird out_parameters bei einem späteren Aufruf noch einmal an GET_PRINT_PARAMETERS übergeben, so werden diese Felder nicht berücksichtigt.
Im allen anderen Modus sind alle Felder in out_parameters mit Werten belegt. (eventuell mit Defaultwerten).
Das heißt, wird out_parameters bei einem späteren Aufruf noch einmal an GET_PRINT_PARAMETERS übergeben, so werden diese Felder berücksichtigt.

Generell sollte der Rückgabeparameter VALID abgefragt werden. Er hat die möglichen Werte TRUE, FALSE. Im Falle FALSE wurde entweder der Benutzerdialog (Druckpopup) abgebrochen oder der FB wurde mit Druckparametern aufgerufen, mit denen später nicht sinnvoll gedruckt werden kann (z.B. Drucken im Batch auf einen Frontend-Drucker).

Beispiel

* Normale Bestimmung der Druckparameter
DATA: PARAMS LIKE PRI_PARAMS,
      VALID  TYPE C.

CALL FUNCTION 'GET_PRINT_PARAMETERS'
  EXPORTING DESTINATION           = 'LT50'
  IMPORTING OUT_PARAMETERS        = PARAMS
          VALID                 = VALID.
IF VALID <> SPACE.
  NEW-PAGE PRINT ON PARAMETERS PARAMS.
ENDIF.

* Bestimmen der Parameter für Drucken und Archivierung.
DATA: PRI_PARAMS LIKE PRI_PARAMS,
      ARC_PARAMS LIKE ARC_PARAMS,
      VALID      TYPE C.

CALL FUNCTION 'GET_PRINT_PARAMETERS'
  IMPORTING OUT_PARAMETERS         = PRI_PARAMS
            OUT_ARCHIVE_PARAMETERS = ARC_PARAMS
            VALID                  = VALID.
IF VALID <> SPACE.
  NEW-PAGE PRINT ON PARAMETERS         PRI_PARAMS
                    ARCHIVE PARAMETERS ARC_PARAMS.
ENDIF.

* Bestimmen der Parameter für einen BATCH-Job
DATA: PARAMS LIKE PRI_PARAMS,
      VALID  TYPE C.

CALL FUNCTION 'GET_PRINT_PARAMETERS'
  EXPORTING MODE                  = 'BATCH'
            REPORT                = 'MYREPORT'
  IMPORTING OUT_PARAMETERS        = PARAMS
          VALID                 = VALID.
IF VALID <> SPACE.
  CALL FUNCTION 'JOB_OPEN' ....  EXPORTING JOBCOUNT ...
  SUBMIT MYREPORT VIA JOB 'MY_JOB' NUMBER JOBCOUNT
         TO SAP-SPOOL WITHOUT SPOOL DYNPRO
            SPOOL PARAMTERS PARAMS.
  CALL FUNCTION 'JOB_CLOSE' ...
ENDIF.

* Ändern der Druckparameter
CALL FUNCTION 'GET_PRINT_PARAMETERS'       "Beschaffen von
  EXPORTING NO_DIALOG             = 'X'    "Druckparametern
  IMPORTING OUT_PARAMETERS        = PARAMS.
...

CALL FUNCTION 'GET_PRINT_PARAMETERS'       "Verändern der
  EXPORTING NO_DIALOG             = 'X'    "Druckparameter
            IN_PARAMETERS         = PARAMS
            LIST_NAME             = 'NEW-LIST'
  IMPORTING OUT_PARAMETERS        = PARAMS.

Parameter

ABAP_LIST
ARCHIVE_ID
ARCHIVE_INFO
ARCHIVE_MODE
ARCHIVE_REPORT
ARCHIVE_TEXT
AR_OBJECT
AUTHORITY
COPIES
COVER_PAGE
DATA_SET
DEFAULT_SPOOL_SIZE
DEPARTMENT
DESTINATION
DRAFT
EXPIRATION
HOST_COVER_PAGE
IMMEDIATELY
IN_ARCHIVE_PARAMETERS
IN_PARAMETERS
LAYOUT
LINE_COUNT
LINE_SIZE
LIST_NAME
LIST_TEXT
MODE
NEW_LIST_ID
NO_DIALOG
NO_FRAMES
OUT_ARCHIVE_PARAMETERS
OUT_PARAMETERS
PO_FAX_STORE
PRIORITY
PROTECT_LIST
RECEIVER
RELEASE
REPORT
SAP_COVER_PAGE
SAP_OBJECT
SUPPRESS_SHADING
TYPE
UC_DISPLAY_MODE
USER
USE_ARCHIVENAME_DEF
USE_OLD_LAYOUT
VALID
VALID_FOR_SPOOL_CREATION
WITH_STRUCTURE

Ausnahmen

ARCHIVE_INFO_NOT_FOUND
INVALID_ARCHIVE_PARAMS
INVALID_PRINT_PARAMS

Funktionsgruppe

SPRI

TXBHW - Original Tax Base Amount in Local Currency rdisp/max_wprun_time - Maximum work process run time
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 12044 Date: 20240523 Time: 063209 sap01-206 ( 142 ms )

Ansicht Dokumentation