X Version 11
Release 6.4
Protocols
7
cancel: BOOL
Errors: XPBadSequence
This request signals the end of a print document. The resulting document data is assembled and combined
with data that was sent by PrintPutDocumentData.
When cancel is TRUE, the document currently being processed is canceled. The server may discard any
pending output or may produce partial output. If the job was started with XPGetData mode, then the entire
data output stream is implementation-defined for this document.
The XpDocAttr pool that was frozen when the PrintStartDoc request was executed is released when Print-
EndDoc
is called.
PrintStartPage
window: WINDOW
Errors: XPBadSequence, Window
This request indicates the beginning of a single print page within a document. Window is the drawable that
represents the page.
PrintStartPage
causes window to be mapped. Within a PrintStartPage/PrintEndPage sequence, any
attempts to resize, move, or unmap window will be ignored. To resize or move inferiors of window, the stan-
dard semantics used for ConfigureWindow apply, except that the contents of the configured window may be
lost. If the contents of a window are lost, an Expose event is generated.
A Window error is issued if window is not a descendent of the root window of the current print context. An
XPBadSequence
error is issued if PrintStartPage is called in an XPDocRaw document.
Any changes to the XPPageAttr attribute pool must be made before PrintStartPage is executed. Further
modifications can only be made to the attribute pool after a PrintEndPage request is executed.
PrintEndPage
cancel: BOOL
Errors: XPBadContext, XPBadSequence
This request indicates the end of a print page, and causes window to be unmapped. If cancel is TRUE, the
current print page is canceled.
When cancel is TRUE, the job currently being processed is canceled. The server may discard any pending
output or may produce partial output. If the job was started with XPGetData mode, then the entire data out-
put stream is implementation-defined for this page.
The pool of job attributes that was frozen when the PrintStartPage request was executed is freed when
PrintEndPage
is called.