ABAP Keyword Documentation →  ABAP − Reference →  User Dialogs →  Classic Lists →  Creating Lists →  NEW-PAGE → 

NEW-PAGE - spool_options

Short Reference

Syntax

... { PRINT ON [NEW-SECTION] PARAMETERS pri_params
                            [ARCHIVE PARAMETERS arc_params]
                            NO DIALOG }
  | { PRINT OFF } ... .

Extras:

1. ... PRINT ON [NEW-SECTION]

2. ... PARAMETERS pri_params

3. ... ARCHIVE PARAMETERS arc_params

4. ... NO DIALOG

5. ... PRINT OFF

Effect

The addition PRINT ON writes all subsequent output statements to a spool list. The additions [ARCHIVE] PARAMETERS are used to define the spool parameters and the archiving parameters of the spool request. The addition PRINT OFF closes a spool list that has been started with the addition PRINT ON.

Addition 1

... PRINT ON [NEW-SECTION]

Effect

The addition PRINT ON creates a new spool list level. The first output statement after NEW-PAGE PRINT ON opens a new spool request and writes to a spool list in the SAP spool system. The number of the spool request is passed to sy-spono by the first output statement. While it is being created, the spool list is sent page by page to the SAP spool system.

It is not possible to use NEW-PAGE PRINT ON to stack another spool list level directly on to a spool list level created using NEW-PAGE PRINT ON.

A spool list level created using NEW-PAGE PRINT ON can be closed by either NEW-PAGE PRINT OFF, NEW-PAGE PRINT ON NEW-SECTION, the end of the program, or by leaving a screen sequence.

Notes

Example

See Lists, Spooling.

Addition 2

... PARAMETERS pri_params

Addition 3

... ARCHIVE PARAMETERS arc_params

Addition 4

... NO DIALOG

Effect

These additions provide the spool request with spool parameters and archiving parameters. The latter are necessary if you want to archive the spool list using ArchiveLink.

The addition PARAMETERS passes the spool parameters in a structure pri_params of data type PRI_PARAMS from ABAP Dictionary. If archiving is specified in pri_params, archiving parameters must be passed using the addition ARCHIVE PARAMETERS in a structure arc_params of data type ARC_PARAMS from ABAP Dictionary.

Structures of data types PRI_PARAMS and ARC_PARAMS must be filled by the function module GET_PRINT_PARAMETERS. When calling the function module, you can set individual or all spool parameters in the program and/or display a spool dialog window. The function module creates a set of valid spool and archiving parameters for use as pri_params and arc_params and adds these to its output parameters.

If the structures pri_params or arc_params are initial, the spool parameters or archiving parameters created by a call of the function modules GET_PRINT_PARAMETERS with initial input values are used.

The addition NO DIALOG suppresses the spool dialog window that by default appears when using the PRINT ON addition.

Notes

Example

Creates spool lists during the list event AT LINE-SELECTION. The spool parameters are defined by the function module GET_PRINT_PARAMETERS before the basic list is created.

REPORT demo NO STANDARD PAGE HEADING.

DATA: spfli_wa TYPE spfli,
      sflight_wa TYPE sflight.

DATA: print_parameters TYPE pri_params,
      valid_flag       TYPE c LENGTH 1.

START-OF-SELECTION.

  CALL FUNCTION 'GET_PRINT_PARAMETERS'
    IMPORTING
      out_parameters       = print_parameters
      valid                = valid_flag
    EXCEPTIONS
      invalid_print_params = 2
      OTHERS               = 4.

  IF valid_flag = 'X' AND sy-subrc = 0.
    SELECT carrid connid
           FROM spfli
           INTO CORRESPONDING FIELDS OF spfli_wa.
      WRITE: / spfli_wa-carrid, spfli_wa-connid.
      HIDE:    spfli_wa-carrid, spfli_wa-connid.
    ENDSELECT.
  ELSE.
    ...
  ENDIF.

AT LINE-SELECTION.
  NEW-PAGE PRINT ON PARAMETERS print_parameters
                    NO DIALOG.
  SELECT *
         FROM sflight
         INTO sflight_wa
         WHERE carrid = spfli_wa-carrid AND
               connid = spfli_wa-connid.
    WRITE: / sflight_wa-carrid, sflight_wa-connid,
             sflight_wa-fldate ...
  ENDSELECT.
  NEW-PAGE PRINT OFF.

Addition 5

... PRINT OFF

Effect

The addition PRINT OFF closes a spool list level created using NEW-PAGE PRINT ON, sends the current page to the SAP spool system, and releases the associated spool request. Output statements that follow NEW-PAGE PRINT OFF write to the screen list or spool list where the spool list level closed by PRINT OFF was stacked. When the system returns to the print list, the system field sy-spono is switched to the number of the associated spool request directly when the statement NEW-PAGE PRINT OFF is executed.

NEW-PAGE PRINT OFF is ignored by spool list levels not been created using NEW-PAGE PRINT ON.

Note

At the end of the program and at every list event AT LINE-SELECTION, AT PFnn, and AT USER-COMMAND, the statement NEW-PAGE PRINT OFF is executed implicitly.

Exceptions

Catchable Exceptions

CX_SY_NESTED_PRINT_ON