xpstartjob(3xp) [debian man page]
XpStartJob(3Xp) XPRINT FUNCTIONS XpStartJob(3Xp) NAME
XpStartJob - Indicates the beginning of a single print job. SYNOPSIS
cc [ flag... ] file... -lXp [ library... ] #include <X11/extensions/Print.h> void XpStartJob ( display, output_mode ) Display *display; XPSaveData output_mode; ARGUMENTS
display Specifies a pointer to the Display structure; returned from XOpenDisplay. output_mode Specifies how the printer output data is to be handled. DESCRIPTION
XpStartJob signals the beginning of a new print job. If output_mode is XPSpool the X Print Server will automatically spool the printer output. If output_mode is XPGetData, then the X Print Server buffers the document output for retrieval by XpGetDocumentData. In this case, the print server suspends processing further requests on this print context until some other client sends XpGetDocumentData. Subsequent operations that use the print context may be suspended at any time pending the processing of XpGetDocumentData replies to read any buffered output. XpStartJob sets the job-owner job attribute (included in the XPJobAttr pool) immediately prior to issuing the PrintStartJob request. On POSIX systems, the job-owner attribute is set using getpwuid_r on the result of getuid. This attribute may be used by the X Print Server to identify the user to the spooler. All changes to the XPJobAttr attribute pool (see XpSetAttributes) must be made prior to calling XpStartJob, after which an XPBadSequence will be generated if changes are attempted, until XpEndJob is called. For clients selecting XPPrintMask (see XpSelectInput), the event XPPrintNotify will be generated with its detail field set to XPStartJobNo- tify when the X Print Server has completed the PrintStartJob request. Conceptually, a "Job" is a collection of "Documents", where each Document is in turn a collection of "Pages". Depending on the print facil- ities underlying the X Print Server, these delineations may be mapped by a DDX driver into real functionality (e.g. see the server attribute multiple-documents-supported). STRUCTURES
The XPSaveData values for output_mode are defined in <X11/extensions/Print.h>. : #define XPSpool 1 /* Job data sent to spooler */ #define XPGetData 2 /* Job data via XpGetDocumentData */ DIAGNOSTICS
BadValue The value specified for output_mode is not valid. 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, XpEndDoc prior to XpStartDoc). SEE ALSO
XpEndJob(3Xp), XpGetDocumentData(3Xp), XpSelectInput(3Xp), XpSetAttributes(3Xp), XpStartJob(3Xp) X Version 11 libXp 1.0.0 XpStartJob(3Xp)
Check Out this Related Man Page
XpStartDoc(3Xp) XPRINT FUNCTIONS XpStartDoc(3Xp) NAME
XpStartDoc - Indicates the beginning of a print document. SYNOPSIS
cc [ flag... ] file... -lXp [ library... ] #include <X11/extensions/Print.h> void XpStartDoc ( display, type ) Display *display; XPDocumentType type; ARGUMENTS
display Specifies a pointer to the Display structure; returned from XOpenDisplay. type Specifies the type of document. It can be either XPDocRaw or XPDocNormal. DESCRIPTION
XpStartDoc signals the beginning of a new print document. If type is XPDocRaw, then the client will provide all the data for the resulting document using XpPutDocumentData; the X Print Server will not write any data into the resulting document. Calling XpStartPage in a XPDocRaw document will generate an XPBadSequence error. For more information, see XpPutDocumentData. If type is XPDocNormal, then the X Print Server will generate document data, and depending on the DDX driver, can incorporate additional data from XpPutDocumentData into the output. For more information, see XpPutDocumentData. All changes to the XPDocAttr attribute pool (see XpSetAttributes) must be made prior to calling XpStartDoc, after which an XPBadSequence will be generated if changes are attempted, until XpEndDoc is called. The application is not required to call XpStartDoc and XpEndDoc in the process of printing. The "document" delineation may not be useful from the application's or spooler's perspective, hence is optional. If XpStartPage is called immediately after XpStartJob then a synthetic XpStartDoc with XPDocNormal will be assumed by the X Print Server prior to XpStartPage (i.e. the XPStartDocNotify and XPStartPageNotify events will have the same sequence number). Likewise, if XpEndJob is called immediately after XpEndPage then a synthetic XpEndDoc will be assumed by the X Print Server prior to XpEndJob (i.e., the XPEndDocNotify and XPEndJobNotify events will have the same sequence number). For clients selecting XPPrintMask (see XpSelectInput), the event XPPrintNotify will be generated with its detail field set to XPStartDocNo- tify. STRUCTURES
The XPDocumentType values are defined in <X11/extensions/Print.h>: #define XPDocNormal 1 /* Doc data handled by Xserver*/ #define XPDocRaw 2 /* Doc data passed through Xserver*/ DIAGNOSTICS
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, XpEndDoc prior to XpStartDoc). BadValue The value specified for type is not valid. FILES
<X11/extensions/Print.h> SEE ALSO
XpEndDoc(3Xp), XpEndJob(3Xp), XpEndPage(3Xp), XpPutDocumentData(3Xp), XpSelectInput(3Xp), XpSetAttributes(3Xp), XpStartJob(3Xp), XpStart- Page(3Xp) X Version 11 libXp 1.0.0 XpStartDoc(3Xp)