<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>XCB: XCB Core API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">XCB <span id="projectnumber">1.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>XCB Core API</h1> </div>
</div>
<div class="contents">
<p>Core API of the XCB library.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__iterator__t.html">xcb_generic_iterator_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic iterator. <a href="structxcb__generic__iterator__t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__reply__t.html">xcb_generic_reply_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic reply. <a href="structxcb__generic__reply__t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic event. <a href="structxcb__generic__event__t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__ge__event__t.html">xcb_ge_event_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">GE event. <a href="structxcb__ge__event__t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic error. <a href="structxcb__generic__error__t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__void__cookie__t.html">xcb_void_cookie_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic cookie. <a href="structxcb__void__cookie__t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Container for authorization information. <a href="structxcb__auth__info__t.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga33a326c569db79d44ac7f50449cd41a9">X_PROTOCOL</a>   11</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaec218574c2dba2befb7b797b55d5b146">X_PROTOCOL_REVISION</a>   0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gae3ab23b2215dc45af366b61a84b40272">X_TCP_PORT</a>   6000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7a30f2a3be1abba1232db075a0f0876f"></a><!-- doxytag: member="XCB_Core_API::XCB_TYPE_PAD" ref="ga7a30f2a3be1abba1232db075a0f0876f" args="(T, I)" -->
#define </td><td class="memItemRight" valign="bottom"><b>XCB_TYPE_PAD</b>(T, I)   (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gafa5402f36a6f6b5def0e98c4a452dc82">XCB_NONE</a>   0L</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gacfad5acd9f27e048614dce1f7ea69ed8">XCB_COPY_FROM_PARENT</a>   0L</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3a6ff159310850f5e28b018192a4a0d0">XCB_CURRENT_TIME</a>   0L</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga47e7b30cb867e921290ab333b88184dd">XCB_NO_SYMBOL</a>   0L</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga8af532123ce5fb1c75ded03a0d77691f">xcb_connection_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XCB Connection structure. <a href="#ga8af532123ce5fb1c75ded03a0d77691f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga5c434ae83bd5822deb8e20ea517071b6">xcb_auth_info_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Container for authorization information. <a href="#ga5c434ae83bd5822deb8e20ea517071b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga8615b6e0d78ed5de111d9202530cebe9">xcb_extension_t</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga9361ead09eb756ba9cc8953c4569a789">xcb_flush</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces any buffered output to be written to the server. <a href="#ga9361ead09eb756ba9cc8953c4569a789"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaac2771a6f8f77b574bcebcec3a7de977">xcb_get_maximum_request_length</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum request length that this server accepts. <a href="#gaac2771a6f8f77b574bcebcec3a7de977"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga365edf27111a8dd4e1d2831f652315e7">xcb_prefetch_maximum_request_length</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prefetch the maximum request length without blocking. <a href="#ga365edf27111a8dd4e1d2831f652315e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga1152db5668f718d1b3daf9b40712b0dd">xcb_wait_for_event</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next event or error from the server. <a href="#ga1152db5668f718d1b3daf9b40712b0dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3289f98c49afa3aa56f84f741557a434">xcb_poll_for_event</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next event or error from the server. <a href="#ga3289f98c49afa3aa56f84f741557a434"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3ee7f1ad9cf0a9f1716d5c22405598fc">xcb_request_check</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__void__cookie__t.html">xcb_void_cookie_t</a> cookie)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the error for a request, or NULL if none can ever arrive. <a href="#ga3ee7f1ad9cf0a9f1716d5c22405598fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gabb6bc06a4ee73b3b820847a02bd8bfcb">xcb_discard_reply</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, unsigned int sequence)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Discards the reply for a request. <a href="#gabb6bc06a4ee73b3b820847a02bd8bfcb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structxcb__query__extension__reply__t.html">xcb_query_extension_reply_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3cbee434e4859a00d685bbdf1e299b9e">xcb_get_extension_data</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> *ext)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Caches reply information from QueryExtension requests. <a href="#ga3cbee434e4859a00d685bbdf1e299b9e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaa3c0a602c213180792c2668f8056a324">xcb_prefetch_extension_data</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> *ext)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prefetch of extension data into the extension cache. <a href="#gaa3c0a602c213180792c2668f8056a324"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structxcb__setup__t.html">xcb_setup_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gafc379a27800bf735818a0760bd036321">xcb_get_setup</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access the data returned by the server. <a href="#gafc379a27800bf735818a0760bd036321"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga537e3cea89389382533957444eaa13fd">xcb_get_file_descriptor</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access the file descriptor of the connection. <a href="#ga537e3cea89389382533957444eaa13fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga70a6bade94bd2824db552abcf5fbdbe3">xcb_connection_has_error</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test whether the connection has shut down due to a fatal error. <a href="#ga70a6bade94bd2824db552abcf5fbdbe3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga6a5bf0156ada8c8863461073adefc7e2">xcb_connect_to_fd</a> (int fd, <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> *auth_info)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the X server. <a href="#ga6a5bf0156ada8c8863461073adefc7e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gad562fe46469d419a81d5d9b20a659eaa">xcb_disconnect</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the connection. <a href="#gad562fe46469d419a81d5d9b20a659eaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gacdcc135342419d73b45e4f5499f26b20">xcb_parse_display</a> (const char *name, char **host, int *display, int *screen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a display string name in the form documented by X(7x). <a href="#gacdcc135342419d73b45e4f5499f26b20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga094470586356d1764e69c9a1882966c3">xcb_connect</a> (const char *displayname, int *screenp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the X server. <a href="#ga094470586356d1764e69c9a1882966c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaba02ef0d79d42c863842ae7eb8dd67a2">xcb_connect_to_display_with_auth_info</a> (const char *display, <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> *auth, int *screen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the X server, using an authorization information. <a href="#gaba02ef0d79d42c863842ae7eb8dd67a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3208afc306e3c564435a6ecbaddf80d1">xcb_generate_id</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates an XID for a new object. <a href="#ga3208afc306e3c564435a6ecbaddf80d1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Core API of the XCB library. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga33a326c569db79d44ac7f50449cd41a9"></a><!-- doxytag: member="xcb.h::X_PROTOCOL" ref="ga33a326c569db79d44ac7f50449cd41a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define X_PROTOCOL   11</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current protocol version </p>
</div>
</div>
<a class="anchor" id="gaec218574c2dba2befb7b797b55d5b146"></a><!-- doxytag: member="xcb.h::X_PROTOCOL_REVISION" ref="gaec218574c2dba2befb7b797b55d5b146" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define X_PROTOCOL_REVISION   0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current minor version </p>
</div>
</div>
<a class="anchor" id="gae3ab23b2215dc45af366b61a84b40272"></a><!-- doxytag: member="xcb.h::X_TCP_PORT" ref="gae3ab23b2215dc45af366b61a84b40272" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define X_TCP_PORT   6000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>X_TCP_PORT + display number = server port for TCP transport </p>
</div>
</div>
<a class="anchor" id="gacfad5acd9f27e048614dce1f7ea69ed8"></a><!-- doxytag: member="xcb.h::XCB_COPY_FROM_PARENT" ref="gacfad5acd9f27e048614dce1f7ea69ed8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCB_COPY_FROM_PARENT   0L</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters </p>
</div>
</div>
<a class="anchor" id="ga3a6ff159310850f5e28b018192a4a0d0"></a><!-- doxytag: member="xcb.h::XCB_CURRENT_TIME" ref="ga3a6ff159310850f5e28b018192a4a0d0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCB_CURRENT_TIME   0L</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t </p>
</div>
</div>
<a class="anchor" id="ga47e7b30cb867e921290ab333b88184dd"></a><!-- doxytag: member="xcb.h::XCB_NO_SYMBOL" ref="ga47e7b30cb867e921290ab333b88184dd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCB_NO_SYMBOL   0L</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables </p>
</div>
</div>
<a class="anchor" id="gafa5402f36a6f6b5def0e98c4a452dc82"></a><!-- doxytag: member="xcb.h::XCB_NONE" ref="gafa5402f36a6f6b5def0e98c4a452dc82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCB_NONE   0L</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XCB_NONE is the universal null resource or null atom parameter value for many core X requests </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga5c434ae83bd5822deb8e20ea517071b6"></a><!-- doxytag: member="xcb.h::xcb_auth_info_t" ref="ga5c434ae83bd5822deb8e20ea517071b6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Container for authorization information. </p>
<p>A container for authorization information to be sent to the X server. </p>
</div>
</div>
<a class="anchor" id="ga8af532123ce5fb1c75ded03a0d77691f"></a><!-- doxytag: member="xcb.h::xcb_connection_t" ref="ga8af532123ce5fb1c75ded03a0d77691f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XCB Connection structure. </p>
<p>A structure that contain all data that XCB needs to communicate with an X server. Opaque structure containing all data that XCB needs to communicate with an X server. </p>
</div>
</div>
<a class="anchor" id="ga8615b6e0d78ed5de111d9202530cebe9"></a><!-- doxytag: member="xcb.h::xcb_extension_t" ref="ga8615b6e0d78ed5de111d9202530cebe9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opaque structure used as key for xcb_get_extension_data_t. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga094470586356d1764e69c9a1882966c3"></a><!-- doxytag: member="xcb.h::xcb_connect" ref="ga094470586356d1764e69c9a1882966c3" args="(const char *displayname, int *screenp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a>* xcb_connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>displayname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>screenp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the X server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayname,:</td><td>The name of the display. </td></tr>
<tr><td class="paramname">screenp,:</td><td>A pointer to a preferred screen number. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> structure.</dd></dl>
<p>Connects to the X server specified by <code>displayname</code>. If <code>displayname</code> is <code>NULL</code>, uses the value of the DISPLAY environment variable. If a particular screen on that server is preferred, the int pointed to by <code>screenp</code> (if not <code>NULL</code>) will be set to that screen; otherwise the screen will be set to 0. </p>
<p>References <a class="el" href="group__XCB__Core__API.html#gaba02ef0d79d42c863842ae7eb8dd67a2">xcb_connect_to_display_with_auth_info()</a>.</p>
</div>
</div>
<a class="anchor" id="gaba02ef0d79d42c863842ae7eb8dd67a2"></a><!-- doxytag: member="xcb.h::xcb_connect_to_display_with_auth_info" ref="gaba02ef0d79d42c863842ae7eb8dd67a2" args="(const char *display, xcb_auth_info_t *auth, int *screen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a>* xcb_connect_to_display_with_auth_info </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>display</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> * </td>
<td class="paramname"><em>auth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>screen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the X server, using an authorization information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">display,:</td><td>The name of the display. </td></tr>
<tr><td class="paramname">auth,:</td><td>The authorization information. </td></tr>
<tr><td class="paramname">screen,:</td><td>A pointer to a preferred screen number. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> structure.</dd></dl>
<p>Connects to the X server specified by <code>displayname</code>, using the authorization <code>auth</code>. If a particular screen on that server is preferred, the int pointed to by <code>screenp</code> (if not <code>NULL</code>) will be set to that screen; otherwise <code>screenp</code> will be set to 0. </p>
<p>References <a class="el" href="structxcb__auth__info__t.html#a115f8ba8e337562e9f7ba90fc86dd8f2">xcb_auth_info_t::data</a>, <a class="el" href="structxcb__auth__info__t.html#a8dcfcabe85588b0fb45de36a10679c1b">xcb_auth_info_t::name</a>, and <a class="el" href="group__XCB__Core__API.html#ga6a5bf0156ada8c8863461073adefc7e2">xcb_connect_to_fd()</a>.</p>
<p>Referenced by <a class="el" href="group__XCB__Core__API.html#ga094470586356d1764e69c9a1882966c3">xcb_connect()</a>.</p>
</div>
</div>
<a class="anchor" id="ga6a5bf0156ada8c8863461073adefc7e2"></a><!-- doxytag: member="xcb.h::xcb_connect_to_fd" ref="ga6a5bf0156ada8c8863461073adefc7e2" args="(int fd, xcb_auth_info_t *auth_info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a>* xcb_connect_to_fd </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> * </td>
<td class="paramname"><em>auth_info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the X server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fd,:</td><td>The file descriptor. </td></tr>
<tr><td class="paramname">auth_info,:</td><td>Authentication data. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> structure.</dd></dl>
<p>Connects to an X server, given the open socket <code>fd</code> and the <a class="el" href="structxcb__auth__info__t.html" title="Container for authorization information.">xcb_auth_info_t</a> <code>auth_info</code>. The file descriptor <code>fd</code> is bidirectionally connected to an X server. If the connection should be unauthenticated, <code>auth_info</code> must be <code>NULL</code>. </p>
<p>References <a class="el" href="group__XCB__Core__API.html#gad562fe46469d419a81d5d9b20a659eaa">xcb_disconnect()</a>.</p>
<p>Referenced by <a class="el" href="group__XCB__Core__API.html#gaba02ef0d79d42c863842ae7eb8dd67a2">xcb_connect_to_display_with_auth_info()</a>.</p>
</div>
</div>
<a class="anchor" id="ga70a6bade94bd2824db552abcf5fbdbe3"></a><!-- doxytag: member="xcb.h::xcb_connection_has_error" ref="ga70a6bade94bd2824db552abcf5fbdbe3" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xcb_connection_has_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test whether the connection has shut down due to a fatal error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the connection is in an error state; 0 otherwise.</dd></dl>
<p>Some errors that occur in the context of an <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> are unrecoverable. When such an error occurs, the connection is shut down and further operations on the <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> have no effect.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Other functions should document the conditions in which they shut down the connection. </dd></dl>
</div>
</div>
<a class="anchor" id="gabb6bc06a4ee73b3b820847a02bd8bfcb"></a><!-- doxytag: member="xcb.h::xcb_discard_reply" ref="gabb6bc06a4ee73b3b820847a02bd8bfcb" args="(xcb_connection_t *c, unsigned int sequence)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xcb_discard_reply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>sequence</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Discards the reply for a request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server. </td></tr>
<tr><td class="paramname">sequence,:</td><td>The request sequence number from a cookie.</td></tr>
</table>
</dd>
</dl>
<p>Discards the reply for a request. Additionally, any error generated by the request is also discarded (unless it was an _unchecked request and the error has already arrived).</p>
<p>This function will not block even if the reply is not yet available.</p>
<p>Note that the sequence really does have to come from an xcb cookie; this function is not designed to operate on socket-handoff replies. </p>
</div>
</div>
<a class="anchor" id="gad562fe46469d419a81d5d9b20a659eaa"></a><!-- doxytag: member="xcb.h::xcb_disconnect" ref="gad562fe46469d419a81d5d9b20a659eaa" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xcb_disconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the connection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection.</td></tr>
</table>
</dd>
</dl>
<p>Closes the file descriptor and frees all memory associated with the connection <code>c</code>. </p>
<p>Referenced by <a class="el" href="group__XCB__Core__API.html#ga6a5bf0156ada8c8863461073adefc7e2">xcb_connect_to_fd()</a>.</p>
</div>
</div>
<a class="anchor" id="ga9361ead09eb756ba9cc8953c4569a789"></a><!-- doxytag: member="xcb.h::xcb_flush" ref="ga9361ead09eb756ba9cc8953c4569a789" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xcb_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Forces any buffered output to be written to the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>> <code>0</code> on success, <= <code>0</code> otherwise.</dd></dl>
<p>Forces any buffered output to be written to the server. Blocks until the write is complete. </p>
</div>
</div>
<a class="anchor" id="ga3208afc306e3c564435a6ecbaddf80d1"></a><!-- doxytag: member="xcb.h::xcb_generate_id" ref="ga3208afc306e3c564435a6ecbaddf80d1" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t xcb_generate_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocates an XID for a new object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated XID.</dd></dl>
<p>Allocates an XID for a new object. Typically used just prior to various object creation functions, such as xcb_create_window. </p>
<p>References <a class="el" href="structxcb__xc__misc__get__xid__range__reply__t.html#a924e13bb45ff5299bbd69dd56d5331e0">xcb_xc_misc_get_xid_range_reply_t::count</a>, <a class="el" href="structxcb__setup__t.html#a64583429ba05353cf32dd6c368da8ada">xcb_setup_t::resource_id_mask</a>, <a class="el" href="structxcb__xc__misc__get__xid__range__reply__t.html#a24b74b834cf97d6d93c033ff425900d1">xcb_xc_misc_get_xid_range_reply_t::start_id</a>, <a class="el" href="group__XCB__Core__API.html#ga3cbee434e4859a00d685bbdf1e299b9e">xcb_get_extension_data()</a>, <a class="el" href="group__XCB__XCMisc__API.html#ga3f7541e960964c5a16e4c6b54711c905">xcb_xc_misc_get_xid_range()</a>, and <a class="el" href="group__XCB__XCMisc__API.html#ga268077d39aa8bde898411ee3b8766018">xcb_xc_misc_get_xid_range_reply()</a>.</p>
</div>
</div>
<a class="anchor" id="ga3cbee434e4859a00d685bbdf1e299b9e"></a><!-- doxytag: member="xcb.h::xcb_get_extension_data" ref="ga3cbee434e4859a00d685bbdf1e299b9e" args="(xcb_connection_t *c, xcb_extension_t *ext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structxcb__query__extension__reply__t.html">xcb_query_extension_reply_t</a>* xcb_get_extension_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> * </td>
<td class="paramname"><em>ext</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Caches reply information from QueryExtension requests. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection. </td></tr>
<tr><td class="paramname">ext,:</td><td>The extension data. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="structxcb__query__extension__reply__t.html" title="xcb_query_extension_reply_t">xcb_query_extension_reply_t</a> for the extension.</dd></dl>
<p>This function is the primary interface to the "extension cache", which caches reply information from QueryExtension requests. Invoking this function may cause a call to xcb_query_extension to retrieve extension information from the server, and may block until extension data is received from the server.</p>
<p>The result must not be freed. This storage is managed by the cache itself. </p>
<p>References <a class="el" href="group__XCB____API.html#ga96978d012dbd2bbc2816ee9e2bc4807f">xcb_query_extension_reply()</a>.</p>
<p>Referenced by <a class="el" href="group__XCB__Core__API.html#ga3208afc306e3c564435a6ecbaddf80d1">xcb_generate_id()</a>, and <a class="el" href="group__XCB__Core__API.html#ga365edf27111a8dd4e1d2831f652315e7">xcb_prefetch_maximum_request_length()</a>.</p>
</div>
</div>
<a class="anchor" id="ga537e3cea89389382533957444eaa13fd"></a><!-- doxytag: member="xcb.h::xcb_get_file_descriptor" ref="ga537e3cea89389382533957444eaa13fd" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xcb_get_file_descriptor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access the file descriptor of the connection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The file descriptor.</dd></dl>
<p>Accessor for the file descriptor that was passed to the xcb_connect_to_fd call that returned <code>c</code>. </p>
</div>
</div>
<a class="anchor" id="gaac2771a6f8f77b574bcebcec3a7de977"></a><!-- doxytag: member="xcb.h::xcb_get_maximum_request_length" ref="gaac2771a6f8f77b574bcebcec3a7de977" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t xcb_get_maximum_request_length </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the maximum request length that this server accepts. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The maximum request length field.</dd></dl>
<p>In the absence of the BIG-REQUESTS extension, returns the maximum request length field from the connection setup data, which may be as much as 65535. If the server supports BIG-REQUESTS, then the maximum request length field from the reply to the BigRequestsEnable request will be returned instead.</p>
<p>Note that this length is measured in four-byte units, making the theoretical maximum lengths roughly 256kB without BIG-REQUESTS and 16GB with. </p>
<p>References <a class="el" href="structxcb__setup__t.html#adb303663509c8a97a03fce81c784af16">xcb_setup_t::maximum_request_length</a>, <a class="el" href="structxcb__big__requests__enable__reply__t.html#a0530c4aa50c25f0a400dd6091c34e8f9">xcb_big_requests_enable_reply_t::maximum_request_length</a>, <a class="el" href="group__XCB__BigRequests__API.html#ga3b29dd51a194c5168c527dc65d8b3b78">xcb_big_requests_enable_reply()</a>, and <a class="el" href="group__XCB__Core__API.html#ga365edf27111a8dd4e1d2831f652315e7">xcb_prefetch_maximum_request_length()</a>.</p>
</div>
</div>
<a class="anchor" id="gafc379a27800bf735818a0760bd036321"></a><!-- doxytag: member="xcb.h::xcb_get_setup" ref="gafc379a27800bf735818a0760bd036321" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structxcb__setup__t.html">xcb_setup_t</a>* xcb_get_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access the data returned by the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to an <a class="el" href="structxcb__setup__t.html" title="xcb_setup_t">xcb_setup_t</a> structure.</dd></dl>
<p>Accessor for the data returned by the server when the <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> was initialized. This data includes</p>
<ul>
<li>the server's required format for images,</li>
<li>a list of available visuals,</li>
<li>a list of available screens,</li>
<li>the server's maximum request length (in the absence of the BIG-REQUESTS extension),</li>
<li>and other assorted information.</li>
</ul>
<p>See the X protocol specification for more details.</p>
<p>The result must not be freed. </p>
</div>
</div>
<a class="anchor" id="gacdcc135342419d73b45e4f5499f26b20"></a><!-- doxytag: member="xcb.h::xcb_parse_display" ref="gacdcc135342419d73b45e4f5499f26b20" args="(const char *name, char **host, int *display, int *screen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xcb_parse_display </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>display</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>screen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses a display string name in the form documented by X(7x). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name,:</td><td>The name of the display. </td></tr>
<tr><td class="paramname">host,:</td><td>A pointer to a malloc'd copy of the hostname. </td></tr>
<tr><td class="paramname">display,:</td><td>A pointer to the display number. </td></tr>
<tr><td class="paramname">screen,:</td><td>A pointer to the screen number. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on failure, non 0 otherwise.</dd></dl>
<p>Parses the display string name <code>display_name</code> in the form documented by X(7x). Has no side effects on failure. If <code>displayname</code> is <code>NULL</code> or empty, it uses the environment variable DISPLAY. <code>hostp</code> is a pointer to a newly allocated string that contain the host name. <code>displayp</code> is set to the display number and <code>screenp</code> to the preferred screen number. <code>screenp</code> can be <code>NULL</code>. If <code>displayname</code> does not contain a screen number, it is set to <code>0</code>. </p>
</div>
</div>
<a class="anchor" id="ga3289f98c49afa3aa56f84f741557a434"></a><!-- doxytag: member="xcb.h::xcb_poll_for_event" ref="ga3289f98c49afa3aa56f84f741557a434" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a>* xcb_poll_for_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the next event or error from the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server. error status of the operation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The next event from the server.</dd></dl>
<p>Returns the next event or error from the server, if one is available, or returns <code>NULL</code> otherwise. If no event is available, that might be because an I/O error like connection close occurred while attempting to read the next event, in which case the connection is shut down when this function returns. </p>
</div>
</div>
<a class="anchor" id="gaa3c0a602c213180792c2668f8056a324"></a><!-- doxytag: member="xcb.h::xcb_prefetch_extension_data" ref="gaa3c0a602c213180792c2668f8056a324" args="(xcb_connection_t *c, xcb_extension_t *ext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xcb_prefetch_extension_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> * </td>
<td class="paramname"><em>ext</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prefetch of extension data into the extension cache. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection. </td></tr>
<tr><td class="paramname">ext,:</td><td>The extension data.</td></tr>
</table>
</dd>
</dl>
<p>This function allows a "prefetch" of extension data into the extension cache. Invoking the function may cause a call to xcb_query_extension, but will not block waiting for the reply. xcb_get_extension_data will return the prefetched data after possibly blocking while it is retrieved. </p>
</div>
</div>
<a class="anchor" id="ga365edf27111a8dd4e1d2831f652315e7"></a><!-- doxytag: member="xcb.h::xcb_prefetch_maximum_request_length" ref="ga365edf27111a8dd4e1d2831f652315e7" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xcb_prefetch_maximum_request_length </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prefetch the maximum request length without blocking. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server.</td></tr>
</table>
</dd>
</dl>
<p>Without blocking, does as much work as possible toward computing the maximum request length accepted by the X server.</p>
<p>Invoking this function may cause a call to xcb_big_requests_enable, but will not block waiting for the reply. xcb_get_maximum_request_length will return the prefetched data after possibly blocking while the reply is retrieved.</p>
<p>Note that in order for this function to be fully non-blocking, the application must previously have called xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply must have already arrived. </p>
<p>References <a class="el" href="structxcb__setup__t.html#adb303663509c8a97a03fce81c784af16">xcb_setup_t::maximum_request_length</a>, <a class="el" href="structxcb__query__extension__reply__t.html#a3730b3fd65e854ef6967658968f8d683">xcb_query_extension_reply_t::present</a>, <a class="el" href="group__XCB__BigRequests__API.html#ga127f5654f2a302929d684367f1ba8b01">xcb_big_requests_enable()</a>, and <a class="el" href="group__XCB__Core__API.html#ga3cbee434e4859a00d685bbdf1e299b9e">xcb_get_extension_data()</a>.</p>
<p>Referenced by <a class="el" href="group__XCB__Core__API.html#gaac2771a6f8f77b574bcebcec3a7de977">xcb_get_maximum_request_length()</a>.</p>
</div>
</div>
<a class="anchor" id="ga3ee7f1ad9cf0a9f1716d5c22405598fc"></a><!-- doxytag: member="xcb.h::xcb_request_check" ref="ga3ee7f1ad9cf0a9f1716d5c22405598fc" args="(xcb_connection_t *c, xcb_void_cookie_t cookie)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a>* xcb_request_check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structxcb__void__cookie__t.html">xcb_void_cookie_t</a> </td>
<td class="paramname"><em>cookie</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the error for a request, or NULL if none can ever arrive. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server. </td></tr>
<tr><td class="paramname">cookie,:</td><td>The request cookie. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error for the request, or NULL if none can ever arrive.</dd></dl>
<p>The <a class="el" href="structxcb__void__cookie__t.html" title="Generic cookie.">xcb_void_cookie_t</a> cookie supplied to this function must have resulted from a call to xcb_[request_name]_checked(). This function will block until one of two conditions happens. If an error is received, it will be returned. If a reply to a subsequent request has already arrived, no error can arrive for this request, so this function will return NULL.</p>
<p>Note that this function will perform a sync if needed to ensure that the sequence number will advance beyond that provided in cookie; this is a convenience to avoid races in determining whether the sync is needed. </p>
<p>References <a class="el" href="structxcb__void__cookie__t.html#af04f2b3abfc40ac8c7607f6b356548ba">xcb_void_cookie_t::sequence</a>, <a class="el" href="group__XCB____API.html#gafba723066d2b083f0427bd0ec07b849c">xcb_get_input_focus()</a>, and <a class="el" href="group__XCB____API.html#gaab32d1220072c8cf4050feba6673780f">xcb_get_input_focus_reply()</a>.</p>
</div>
</div>
<a class="anchor" id="ga1152db5668f718d1b3daf9b40712b0dd"></a><!-- doxytag: member="xcb.h::xcb_wait_for_event" ref="ga1152db5668f718d1b3daf9b40712b0dd" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a>* xcb_wait_for_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the next event or error from the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c,:</td><td>The connection to the X server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The next event from the server.</dd></dl>
<p>Returns the next event or error from the server, or returns null in the event of an I/O error. Blocks until either an event or error arrive, or an I/O error occurs. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Apr 29 2011 15:45:47 for XCB by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
