Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xpcancelpage(3xp) [debian man page]

XpCancelPage(3Xp)						 XPRINT FUNCTIONS						 XpCancelPage(3Xp)

NAME

       XpCancelPage - Cancels a print page.

SYNOPSIS

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

       void XpCancelPage ( display, discard )
	     Display *display;
	     Bool discard;

ARGUMENTS

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

       discard
	      When TRUE, specifies that XPPrintNotify events with a detail of XPEndPageNotify should be discarded.

DESCRIPTION

       XpCancelPage cancels an in-progress print page. If the job was started with output_mode XPGetData then the data stream to XpGetDocumentData
       is interrupted; no further data for the current page is generated but data for subsequent pages can be generated. For many page description
       languages, such arbitrary interruptions may invalidate the output.

       If  the job was started with output_mode XPSpool then depending on the driver and spooler implementation the entire page may be canceled or
       a partial page may be generated.

       If discard is True all XPPrintNotify events with a detail field of XPEndPageNotify are discarded before XpCancelPage returns.

       For clients selecting XPPrintMask (see XpSelectInput), the event XPPrintNotify is generated with its detail field  set  to  XPEndPageNotify
       when the X Print Server has completed XpCancelPage.

DIAGNOSTICS

       XPBadSequence  The  function  was  not  called  in the proper order with respect to the other X Print Service Extension calls; for example,
		      XpStartPage was called before XpStartJob or was called for a type XPDocRaw document.

SEE ALSO

       XpGetDocumentData(3Xp), XpSelectInput(3Xp), XpStartJob(3Xp), XpStartPage(3Xp)

X Version 11							    libXp 1.0.0 						 XpCancelPage(3Xp)

Check Out this Related Man Page

XpCancelDoc(3Xp)						 XPRINT FUNCTIONS						  XpCancelDoc(3Xp)

NAME

       XpCancelDoc -  Cancels a print document.

SYNOPSIS

       void XpCancelDoc ( display, discard )
	     Display *display;
	     Bool discard;

ARGUMENTS

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

       discard
	      When TRUE, specifies that all XPPrintNotify events with a detail of XPEndPageNotify or XPEndDocNotify should be discarded.

DESCRIPTION

       XpCancelDoc cancels an in-progress document. If the job was started with output_mode XPGetData then the data stream to XpGetDocumentData is
       interrupted; no further data for the current document will be generated but data for subsequent documents can be generated. For	many  page
       description languages such arbitrary termination may invalidate the output.

       If the job was started with output_mode XPSpool then depending on the driver and spooler implementation the entire document may be canceled
       or a partial document may be generated.

       If discard is True all XPPrintNotify events with a detail field of XPEndPageNotify  or  XPEndDocNotify  are  discarded  before  XpCancelDoc
       returns.

       For  clients  selecting XPPrintMask (see XpSelectInput), the event XPPrintNotify will be generated with its detail field set to XPEndDocNo-
       tify.

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).

SEE ALSO

       XpEndDoc(3Xp), XpGetDocumentData(3Xp), XpSelectInput(3Xp), XpStartDoc(3Xp)

X Version 11							    libXp 1.0.0 						  XpCancelDoc(3Xp)
Man Page