Functional specification
36
CDE/Motif PST
CDEnext
XpCancelPage
cancels an in-progress page. If
save_data
to
XpStartJob
is
XPGetData
, then
data available to
XpGetDocumentData
is no longer guaranteed to be valid or recoverable for the
current job. If
save_data
to
XpStartJob
is
XPSpool
, then the X Print Server will discard
previously generated page data and reset in preparation for future pages. Depending on the driver and
spooler configuration, a partial page may be generated (e.g. the driver is directly attached to a device, and
cannot recall data).
All changes to the
XPPageAttr
attribute pool (see
XpSetAttributes
) must be made prior to calling
XpStartPage
, after which a
XPBadSequence
will be generated if changes are attempted, until
XpEndPage
is called.
For clients selecting
XPPrintMask
(see
XpSelectInput
), the event
XPPrintNotify
will be
generated with its detail field set to
XPStartPageNotify
or
XPEndPageNotify
when the X Print
Server has completed
XpStartPage
and
XpEndPage
respectively. If the event
Expose
is also
selected for (see
XSelectInput
), the exposure events will be generated prior to
XPPrintNotify
.
XPStartPageNotify
need not be received prior to calling any other X rendering routines.
For more information, see documentation on the Print Dialog Manager (PDM) and X Print Server Drivers.
Conceptually, a "Job" is a collection of "Documents", where each Document is in turn a collection of
"Pages". Depending on the print facilities underlying the X Print Server (for example, the Distributed
Print Management Facility (PDMF)), these delineations may be mapped by a ddx driver into real
functionality (e.g. see the server attribute
multiple-documents-supported
).
ERRORS/WARNINGS
These functions can generate one of the following errors:
XPBadContext
A valid print context id has not been set prior to making this call.
XPBadSequence
The function was not called in the proper order with respect to the other X
Print Service Extension calls (example,
XpEndPage
prior to
XpStartPage
).
BadWindow
The value specified for
window
is not valid.
XPBadResourceID
The value specified for
window
is not valid for the print context and print
screen. The resource in question must be created in the proper print
context and on the correct screen.
BadValue
The value specified for
exposures
is not valid.
SEE ALSO
XpPutDocumentData
,
XpSelectInput, XpSetAttributes