Function
To control the printing of Composite Documents.
CDPU (CD-count, CD-name, opt-cnt, opt-list)
APL code 1196
GDDM RCP code X'40000000' (1073741824)
Parameters
CD-count (specified by user) (fullword integer)
The number of 8-byte name-parts in CD-name. It must be 1 for MVS, VSE,
and CICS, and 3 for CMS.
CD-name (specified by user) (array of 8-byte character tokens)
This list gives the name-parts, that constitute the name, by which the
composite document interface file is known to the underlying subsystem.
- CICS
- Temporary queue name
- VSE Batch
- DLBL file name (7 characters)
- TSO
- DD name
- CMS
- Filename Filetype Filemode
Either or both of the filetype and filemode can be omitted, in
which case default values of LISTCDP and "*" respectively are
used.
The number of name-parts that can be specified is subsystem-dependent.
GDDM left-justifies each name part.
opt-cnt (specified by user) (fullword integer)
The number of fullwords in opt-list. Zero can be specified to indicate
that opt-list is empty and is not to be inspected.
opt-list (specified by user) (an array of fullword integers)
Printing options, ignored in cases where the target printer does not
support the corresponding facility. A default value is used for an
element that is missing, or has a value of zero. Each element of the
array can be one of:
- 1
- Number of uncollated copies. The default is one copy. This option
applies only to family-1 IPDS printers.
- 2
- Duplex control:
- 1
- Simplex - the default.
- 2
- Normal duplex.
- 3
- Tumble duplex.
- 3
- View control.
This option applies on CICS, TSO, and CMS only, and then only when the
document is viewed.
- 0
- View the entire document.
- +n
- Draw page n with images included.
- -n
- Draw page n with images indicated by boxes.
If +n or -n is specified, the CDPU call creates a GDDM page containing
the required output, but leaves the input or output for the application
program to process.
- 4
- Deletion control:
- 0
- Same as 1 (the default).
- 1
- The input file is not deleted.
- 2
- The input file is deleted.
- 3
- The input file is deleted only if processing has been completed
successfully (see note below).
- 4
- The input file is deleted only if processing has not been completed
successfully.
Note: Where "successfully" means there have been no messages, except
informational ones generated while the document is being processed.
Description
Print or view a composite document. The existing contents of the page, if
any, are deleted by a call to CDPU.
If an application calls the CDPU with the view control parameter set to a
non-zero value, the application can control how the document is browsed.
The CDPU creates a GDDM page containing the specified document page, but
does no input or output. The application must issue its own ASREAD (or
other input/output call) and interpret the returned values. In addition
the application can:
- Define a graphics field for the document page to be shown in. The
default is a field covering the whole screen.
- Display instructions to the user.
- Test for requests for document pages beyond the document end.
Note: If the IMGINIT,WHITE procopt is active, the whole screen will be
white, not just that part of the screen which represents the page.
For more information on the printing of Composite Documents, refer to the
GDDM Base Application Programming Guide.
Principal errors
- ADM2758 E
- COMPOSITE DOCUMENTS ARE NOT SUPPORTED FOR THIS DEVICE
- ADM2760 E
- FIELD NOT CONVERTED
- ADM2775 E
- INVALID COMPOSITE DOCUMENT NAME COUNT, n
- ADM2776 W
- INVALID NUMBER OF OPTIONS, n
- ADM2777 W
- INVALID PARAMETER. COPY COUNT n IS NEGATIVE
- ADM2778 W
- INVALID PARAMETER. DUPLEX CONTROL VALUE n IS INVALID
- ADM2779 W
- COMPOSITE DOCUMENT CONTAINS ERRORS
- ADM2780 W
- INVALID ACTIVE ENVIRONMENT GROUP ON PAGE n
- ADM2782 W
- GRAPHIC POSITION IS OFF PAGE
- ADM2795 W
- DELETION CONTROL VALUE n IS INVALID - FILE NOT DELETED
|