Z-INFPRA

This document covers the following topics:

Description

Return the print defaults of a cabinet.

This subprogram is the same as Z-INFPR with the exception that it also returns the parameters Left-margin and Wrap-printed-line.

When you do not specify the parameter Cabinet (i.e. if the only parameter you specify is Logical-printer-name), this subprogram returns the printer destination (TID or LU) for the printer and the associated printer profile.

When you specify the parameter Cabinet, this subprogram returns the print defaults for the cabinet.

Note:
When you specify both parameters, your specification for Logical-printer-name is ignored and the print defaults are returned.

Parameters

Parameter Format In Out Remarks
Return-code N2   X  
Cabinet A8 R*   The name of the cabinet for which the print defaults are to be returned. If you want to return the printer destination (TID or LU), this parameter must be blank.
Logical-printer-name A32 R* X The name of the printer.
TID/LU A8   X The printer destination for the specified printer. Only returned when Cabinet is blank.
Printer-profile A32   X The name of the printer profile to be used when an object is printed.
Formatting-profile A32   X The name of the profile to be used when a document is to be formatted.
Page-length N4   X The number of lines per page.
Page-width N4   X The number of characters per line.
Con-form A1   X If not marked, the user cannot use Con-form. In this case, the user cannot use the commands FORMAT and OUTPUT, and cannot ADD, DISPLAY or MODIFY a printer profile.
Print-banner A1   X If marked, the "Info" screen information is printed.
Print-notes A1   X If marked, attached notes, cover notes and enclosures are printed.
Print-address A1   X If marked, the addressee list of a mail item is printed.
Left-margin N2   X The number of blank spaces at the beginning of each printed line. Only returned if you specify the parameter Cabinet. Not returned for Logical-printer-name.
Wrap-printed-line A1   X If marked, printed lines are wrapped. If not marked, they are truncated. Only returned if you specify the parameter Cabinet. Not returned for Logical-printer-name.

Return Codes

00 Success
02 Invalid cabinet name or - in batch mode only - locked cabinet
91 Printer association not found

Subprograms

None

Example

DEFINE DATA
LOCAL
*
1 RETURN-CODE          (N2)
1 CABINET              (A8)
1 LOGICAL-PRINTER-NAME (A32)
1 TID/LU               (A8)
1 PRINTER-PROFILE      (A32)
1 FORMATTING-PROFILE   (A32)
1 PAGE-LENGTH          (N4)
1 PAGE-WIDTH           (N4)
1 CON-FORM             (A1)
1 PRINT-BANNER         (A1)
1 PRINT-NOTES          (A1)
1 PRINT-ADDRESS        (A1)
1 LEFT-MARGIN          (N2)
1 WRAP-PRINTED-LINE    (A1)
*
END-DEFINE
*
MOVE 'Cabinet' TO CABINET
*
CALLNAT 'Z-INFPRA'
  RETURN-CODE
  CABINET
  LOGICAL-PRINTER-NAME
  TID/LU
  PRINTER-PROFILE
  FORMATTING-PROFILE
  PAGE-LENGTH
  PAGE-WIDTH
  CON-FORM
  PRINT-BANNER
  PRINT-NOTES
  PRINT-ADDRESS
  LEFT-MARGIN
  WRAP-PRINTED-LINE
*
WRITE
  '='    CABINET /
  '='    TID/LU /
  '='    LOGICAL-PRINTER-NAME /
  '='    PRINTER-PROFILE /
  '='    FORMATTING-PROFILE /
  '='    PAGE-LENGTH /
  '='    PAGE-WIDTH /
  '='    CON-FORM /
  '='    PRINT-BANNER /
  '='    PRINT-NOTES /
  '='    PRINT-ADDRESS /
  '='    LEFT-MARGIN /
  '='    WRAP-PRINTED-LINE //
*
IF RETURN-CODE NE 0
  WRITE / 'Return code' RETURN-CODE
ELSE
  WRITE / 'Return status OK'
END-IF
*
END