<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xflushman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XFlush.man,v 1.3 2003/04/28 22:17:54 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XFlush</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XFlush</refname>
<refname>XSync</refname>
<refname>XEventsQueued</refname>
<refname>XPending</refname>
<refpurpose>handle output buffer or event queue</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XFlush&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para> 

<para>int XSync&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Bool <emphasis remap='I'>discard</emphasis>&hairsp;);</para> 

<para>int XEventsQueued&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int <emphasis remap='I'>mode</emphasis>&hairsp;);</para> 

<para>int XPending&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>discard</emphasis></term>
  <listitem>
<para>Specifies a Boolean value that indicates whether 
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>
discards all events on the event queue.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>mode</emphasis></term>
  <listitem>
<para>Specifies the mode.
You can pass
<emphasis remap='I'>&hairsp;QueuedAlready&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;QueuedAfterFlush&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;QueuedAfterReading&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XFlush&hairsp;</emphasis>
function
flushes the output buffer.
Most client applications need not use this function because the output
buffer is automatically flushed as needed by calls to
<emphasis remap='I'>&hairsp;XPending&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XNextEvent&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;XWindowEvent&hairsp;</emphasis>.
Events generated by the server may be enqueued into the library's event queue.</para>

<para>The
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>
function
flushes the output buffer and then waits until all requests have been received
and processed by the X server.
Any errors generated must be handled by the error handler.
For each protocol error received by Xlib,
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>
calls the client application's error handling routine (see section 11.8.2).
Any events generated by the server are enqueued into the library's 
event queue.</para>

<para>Finally, if you passed 
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>
does not discard the events in the queue.
If you passed 
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>
discards all events in the queue,
including those events that were on the queue before
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>
was called.
Client applications seldom need to call
<emphasis remap='I'>&hairsp;XSync&hairsp;</emphasis>.</para>

<para>If mode is 
<emphasis remap='I'>&hairsp;QueuedAlready&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
returns the number of events
already in the event queue (and never performs a system call).
If mode is 
<emphasis remap='I'>&hairsp;QueuedAfterFlush&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue, 
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
flushes the output buffer, 
attempts to read more events out of the application's connection,
and returns the number read.
If mode is 
<emphasis remap='I'>&hairsp;QueuedAfterReading&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
returns the number of events already in the queue if the number is nonzero. 
If there are no events in the queue, 
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
attempts to read more events out of the application's connection 
without flushing the output buffer and returns the number read.</para>

<para><emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
always returns immediately without I/O if there are events already in the
queue.
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
with mode 
<emphasis remap='I'>&hairsp;QueuedAfterFlush&hairsp;</emphasis>
is identical in behavior to
<emphasis remap='I'>&hairsp;XPending&hairsp;</emphasis>.
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
with mode
<emphasis remap='I'>&hairsp;QueuedAlready&hairsp;</emphasis>
is identical to the
<emphasis remap='I'>&hairsp;XQLength&hairsp;</emphasis>
function.</para>

<para>The
<emphasis remap='I'>&hairsp;XPending&hairsp;</emphasis>
function returns the number of events that have been received from the
X server but have not been removed from the event queue.
<emphasis remap='I'>&hairsp;XPending&hairsp;</emphasis>
is identical to
<emphasis remap='I'>&hairsp;XEventsQueued&hairsp;</emphasis>
with the mode
<emphasis remap='I'>&hairsp;QueuedAfterFlush&hairsp;</emphasis>
specified.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>AllPlanes(3X11),
XIfEvent(3X11),
XNextEvent(3X11),
XPutBackEvent(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

