background image
6
December 15, 1997
Protocols
6
Protocols
Release 6.4
X Version 11
This request allows an application to send and incorporate data into the print output. It functions in two
modes, depending on whether the PrintStartDoc driver-mode is set to XPDocNormal or XPDocRaw:
XPDocNormal
PrintPutDocumentData
sends data to the print server and integrates data
into the output. The root of the drawable must be the root of the current print
context. The doc-format and options parameters describe the format of data,
which in turn guides the way the server interprets it. The xp-embedded-for-
mats-supported
attribute in the XPPrinterAttr pool defines valid values
for doc-format in this mode, else a Match error is issued.
XPDocRaw
PrintPutDocumentData
sends data directly to the print server output. The
print server does not emit document or page control codes into the output,
and data is passed through unmodified. Drawable must be None, else a
Drawable
error is issued. The xp-raw-formats-supported attribute in the
XPPrinterAttr
pool defines valid values for doc-format in this mode, else a
Match
error is issued.
If doc-format is not in xp-embedded-formats-supported or xp-raw-formats-supported a Value error is
issued. The options field is implementation-dependent and the permitted values may depend on the current
settings of other attributes and the value of doc-format. If an unknown options value is specified a Value
error is issued, else if options is not valid in the current state a Match error is issued.
PrintStartDoc
driver-mode: {XPDocNormal, XPDocRaw}
Errors: Value, XPBadSequence
This request indicates the beginning of an individual document within a print job. The server performs the
actions necessary to define a new document, and generates an XPPrintNotify event with its detail field set to
XPStartDocNotify
.
The value of driver-mode can be:
XPDocNormal
Print server generates document data. Depending on the DDX driver, it can
incorporate data from PrintPutDocumentData into the document.
XPDocRaw
The client provides all data for the document using PrintPutDocument-
Data
. The print server does not generate any data of its own into the docu-
ment.
If PrintStartPage is sent immediately after PrintStartJob, then a synthetic PrintStartDoc with driver-
mode XPDocNormal will be generated internally by print server before PrintStartPage.
Any changes to the XPDocAttr attribute pool must be made before PrintStartDoc is executed. Further
modifications can only be made to the attribute pool after a PrintEndDoc request is executed.
PrintEndDoc