Manual Pages for UNIX Operating System command usage for man XpStartDoc

XPRINT FUNCTIONS                                  XpStartDoc(3Xp)



NAME
     XpStartDoc -  Indicates the beginning of a print document.

SYNOPSIS
     cc [ flag... ] file... -lXp [ library... ]
           cc [ flag... ] file... -lXp [ library... ]
           #include 

     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  XPDo-
          cRaw 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  gen-
     erate  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 XpSetAttri-
     butes) 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" delinea-
     tion 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 XPStartPageNo-
     tify  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



X Version 11        Last change: libXp 1.0.0                    1






XPRINT FUNCTIONS                                  XpStartDoc(3Xp)



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

STRUCTURES
     The     XPDocumentType     values     are     defined     in
     :


         #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 Ser-
                    vice Extension calls (example, XpEndDoc prior
                    to XpStartDoc).

     BadValue       The value specified for type is not valid.

FILES
     
SEE ALSO
     XpEndDoc(3Xp),        XpEndJob(3Xp),         XpEndPage(3Xp),
     XpPutDocumentData(3Xp),                  XpSelectInput(3Xp),
     XpSetAttributes(3Xp), XpStartJob(3Xp), XpStartPage(3Xp)

ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | x11/library/libxp           |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |_____________________________|_____________________________|








X Version 11        Last change: libXp 1.0.0                    2