PRINT-DOCUMENT

File 213
Statement PROCESS
Task Print document

Relevant Error Codes

Code Text
506 Data set is migrated
530 Access denied by Security facility
556 File is in use
701 DSNAME missing
733 User ID does not exist
749 PVS (CATID) not available
750 Invalid operand within operand list
798 Task was not started under TSOS.
799 Entire Systems Management Adapter internal error
809 Subsystem not active
856 Operator unable to mount volume
883 Dataset is full
889 Permanent I/O error while writing dataset
903 Dynamic allocation failed for temporary dataset
991 Unknown product
998 Member not found

Field Descriptions

Dictionary Field Name Format/

Length/

Desc/

Mu

Description

ADDITIONAL-COPIES (A3) Number of additional copies.
  D ADDITIONAL-COPIES=0|integer1..255
    See the description of the ADDITIONAL-COPIES parameter of the command PRINT-DOCUMENT.
CHARACTER-SETS (A8) Name of fonts or font pools.
  D CHARACTER-SETS=*BY-EXTENDED-NAME(<alphanum_name_1...8>)
    See the description of the CHARACTER-SETS parameter of the command PRINT-DOCUMENT.
COMMAND-RESPONSE (A253) PRINT-DOCUMENT command response.
DELETE-AFTER-PRINT (A3) Delete file after print: YES or NO.
  D  
DSNAME (A54) Required if no RECORD is given.
  D Name of the file to be printed.
    Note that FUNCTION=CLOSE is required to start the printout.
ELEMENT (A64) Name of the LMS element to be printed.
  D  
ELEMENT-PASSWORD (A8) Password for protected LMS element.
  D  
ELEMENT-TYPE (A8) Type of LMS element to be printed.
  D  
ELEMENT-VERSION (A24) Version of LMS element to be printed.
  D  
FACE-SIDE (A8) Face side identifier.
  D See the description of the FACE-SIDE parameter of the command PRINT-DOCUMENT.
FORM-NAME (A8) Name of form.
  D See the description of the FORM-NAME parameter of the command PRINT-DOCUMENT.
FUNCTION (A8) Function to be performed. Possible options:
  D Blank Default. Print a record.
    CLOSE All records have been written.
    Specify this on the last request.
HEADER-PAGE-TEXT (A32) Used for system exits.
  D See the description of the HEADER-PAGE-TEXT parameter of the command PRINT-DOCUMENT.
IDENTIFIER (A8) Required if multiple update views are executing in parallel. All requests for the same view must have the same identifier.
  D  
JOB-ID (A8) Returned for FUNCTION=CLOSE.
JOB-NAME (A8) Name of the job under which the output is to be printed.
  D  
LEFT-MARGIN (A4) Left margin of text.
  D LAYOUT-CONTROL=*PARAMETERS(LEFT-MARGIN=value_1)
    See the description of the LEFT-MARGIN parameter of the command PRINT-DOCUMENT.
LINE-SPACING (A64) File contains ASA print control characters.
  D DOCUMENT-FORMAT=*TEXT(LINE-SPACING=value)
    For an explanation, see the description of the LINE-SPACING parameter of the command PRINT-DOCUMENT.
PAGE-DEFINITION (A8) Page definition to be used for print.
  D PAGE-DEFINITION=*STD/<integer_1...50000>/<alphanum_name_1...8>
    For an explanation, see the description of the PAGE-DEFINITION parameter of the command PRINT-DOCUMENT.
PARAMETER-SET-1 (A253) Extra operands for command PRINT-DOCUMENT.
  D  
PARAMETER-SET-2 (A253) Extra operands for command PRINT-DOCUMENT.
  D  
PASSWORD (A8) Password of protected file.
  D  
RECORD (A253) Record to be printed.
  D Required if no DSNAME/ELEMENT is given.
RECORD-LENGTH (N3) Length of record.
  D  
USER-RESOURCES-FILE (A54) Fully qualified name of a user file containing all resources.
  D USER-RESOURCES-FILE=*STD/<filename_1...44>
     

PRINT-DOCUMENT Programming Notes

PRINT-DOCUMENT is an UPDATE view, that is, data is transmitted from the Natural program (client side) to ESY (server side).

The Entire Systems Management Adapter view PRINT-DOCUMENT returns codes and messages that describe whether the requested operation has been executed successfully or not.

Therefore, the DEFINE DATA section of the Natural program should only contain the fields shown in this example:

1 PRINT-DOCUMENT VIEW OF PRINT-DOCUMENT
  2 ERROR-CODE
  2 ERROR-TEXT
  2 SYSTEM-MESSAGE-CODE
  2 SYSTEM-CODE
  2 COMMAND-RESPONSE
  2 JOB-ID

These fields in a DEFINE DATA statement are the fields returned from the PRINT-DOCUMENT view in Entire Systems Management Adapter to the calling Natural program.

Defining other fields in DDM is not critical, but the access to these fields can lead to unpredictible results.