Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xpputdocumentdata(3xp) [suse man page]

XpPutDocumentData(3Xp)						 XPRINT FUNCTIONS					    XpPutDocumentData(3Xp)

NAME

       void XpPutDocumentData - Sends and incorporates data into the output.

SYNOPSIS

	     cc [ flag... ] file... -lXp [ library... ]
	     #include <X11/extensions/Print.h>

       XpPutDocumentData ( display, drawable, data, data_len, doc_fmt, options )
	     Display *display;
	     Drawable drawable;
	     unsigned char *data;
	     int data_len;
	     char *doc_fmt;
	     char *options;

ARGUMENTS

       display
	      Specifies a pointer to the Display structure; returned from XOpenDisplay.

       drawable
	      Specifies the destination drawable for rendering.

       data   Specifies the device-specific data sent.

       data_len
	      Specifies the number of bytes in data.

       doc_fmt
	      Specifies the type of data sent.	See below for valid values. String limited to XPCS characters.

       options
	      Specifies DDX driver dependent options.	String limited to XPCS characters.

DESCRIPTION

       Depending on type for XpStartDoc, XpPutDocumentData has two modes of operation.

       In  XPDocRaw  mode,  XpPutDocumentData sends data directly to the output, and drawable must be None, else a BadDrawable error is generated.
       The X Print Server does not emit document or page control codes into the output, and data is passed through unmodified. This is useful  for
       sending	previously  constructed  and  completed  documents  using  the X Print Server job control and submission capabilities. The printer
       attribute xp-raw-formats-supported defines the valid values for doc_fmt in this mode. Unsupported values for doc_fmt cause a BadMatch error
       to be generated.

       In  XPDocNormal	mode, XpPutDocumentData sends data to the X Print Server , and depending on the DDX driver implementation, integrates data
       into the output. The parameters doc_fmt and options describe the format of data which guides the  DDX  driver  in  interpreting	data.  The
       printer	attribute  xp-embedded-formats-supported  defines  the	valid values for doc_fmt in this mode, with unsupported values for doc_fmt
       causing a BadMatch error to be generated.

       If doc_fmt is not in either xp-raw-formats-supported or xp-embedded-formats-supported a BadValue error is generated.

       Depending on the DDX driver implementation in use, XpPutDocumentData might be used, for example, to send a simple text file to a Postscript
       DDX  driver that is capable of wrapping the appropriate document and page control constructs around the text so that it can be printed on a
       Postscript printer. Likewise, Encapsulated Postscript Files might be handled. Another use could be to send a TIFF file to a PCL DDX  driver
       that can convert the image from TIFF into PCL and then integrate it into the current PCL output.

       There  is  no  limit to the value of data_len.  XpPutDocumentData automatically decomposes the call into multiple protocol requests to make
       sure that the maximum request size of the server is not exceeded.

DIAGNOSTICS

       BadDrawable    The value specified for drawable is not valid.

       BadMatch       The value specified for doc_fmt is not valid for the current document type or the value specified for is not valid  for  the
		      print context and print screen.

       BadValue       The value specified for doc_fmt is not supported.

       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 (for example,
		      XpPutDocumentData prior to XpStartDoc).

SEE ALSO

       XpStartDoc(3Xp)

X Version 11							    libXp 1.0.0 					    XpPutDocumentData(3Xp)

Check Out this Related 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)
Man Page