Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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 XP-
	      DocNormal.

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	infor-
       mation, 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 Xp-
       PutDocumentData.

       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  Xp-
       StartPage  is  called immediately after XpStartJob then a synthetic Xp-
       StartDoc	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 XP-
       PrintNotify will	be generated with its detail field set to  XPStartDoc-
       Notify.

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 mak-
		      ing this call.

       XPBadSequence  The function was not called in the proper	order with re-
		      spect  to	the other X Print Service Extension calls (ex-
		      ample, 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.3		       XpStartDoc(3Xp)

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | STRUCTURES | DIAGNOSTICS | FILES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XpStartDoc&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help