<!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 BigRequests 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> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>XCB BigRequests API</h1> </div>
</div>
<div class="contents">
<p>BigRequests XCB Protocol Implementation.
<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__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structxcb__big__requests__enable__cookie__t.html" title="xcb_big_requests_enable_cookie_t">xcb_big_requests_enable_cookie_t</a> <a href="structxcb__big__requests__enable__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__big__requests__enable__request__t.html">xcb_big_requests_enable_request_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structxcb__big__requests__enable__request__t.html" title="xcb_big_requests_enable_request_t">xcb_big_requests_enable_request_t</a> <a href="structxcb__big__requests__enable__request__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__big__requests__enable__reply__t.html">xcb_big_requests_enable_reply_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structxcb__big__requests__enable__reply__t.html" title="xcb_big_requests_enable_reply_t">xcb_big_requests_enable_reply_t</a> <a href="structxcb__big__requests__enable__reply__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"><a class="anchor" id="gaa93386383555dde9095b213af50cd2a7"></a><!-- doxytag: member="XCB_BigRequests_API::XCB_BIGREQUESTS_MAJOR_VERSION" ref="gaa93386383555dde9095b213af50cd2a7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>XCB_BIGREQUESTS_MAJOR_VERSION</b>   0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae42b7f057be846736cd6b4dd3f1139ef"></a><!-- doxytag: member="XCB_BigRequests_API::XCB_BIGREQUESTS_MINOR_VERSION" ref="gae42b7f057be846736cd6b4dd3f1139ef" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>XCB_BIGREQUESTS_MINOR_VERSION</b>   0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#ga49a113890815c160da45827c3ae27a7a">XCB_BIG_REQUESTS_ENABLE</a>   0</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaadcab408d7426ead07e9c7edd9fcdfbd"></a><!-- doxytag: member="XCB_BigRequests_API::xcb_big_requests_enable_cookie_t" ref="gaadcab408d7426ead07e9c7edd9fcdfbd" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#gaadcab408d7426ead07e9c7edd9fcdfbd">xcb_big_requests_enable_cookie_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structxcb__big__requests__enable__cookie__t.html" title="xcb_big_requests_enable_cookie_t">xcb_big_requests_enable_cookie_t</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga94a30694ab66005d913f7cfb1fa6404b"></a><!-- doxytag: member="XCB_BigRequests_API::xcb_big_requests_enable_request_t" ref="ga94a30694ab66005d913f7cfb1fa6404b" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structxcb__big__requests__enable__request__t.html">xcb_big_requests_enable_request_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#ga94a30694ab66005d913f7cfb1fa6404b">xcb_big_requests_enable_request_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structxcb__big__requests__enable__request__t.html" title="xcb_big_requests_enable_request_t">xcb_big_requests_enable_request_t</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga30f47b12419b133de91ae5f0b3db24e4"></a><!-- doxytag: member="XCB_BigRequests_API::xcb_big_requests_enable_reply_t" ref="ga30f47b12419b133de91ae5f0b3db24e4" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structxcb__big__requests__enable__reply__t.html">xcb_big_requests_enable_reply_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#ga30f47b12419b133de91ae5f0b3db24e4">xcb_big_requests_enable_reply_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structxcb__big__requests__enable__reply__t.html" title="xcb_big_requests_enable_reply_t">xcb_big_requests_enable_reply_t</a> <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#ga127f5654f2a302929d684367f1ba8b01">xcb_big_requests_enable</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#ga5f956b4ef03cdac1e43db39eefa24613">xcb_big_requests_enable_unchecked</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__big__requests__enable__reply__t.html">xcb_big_requests_enable_reply_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__BigRequests__API.html#ga3b29dd51a194c5168c527dc65d8b3b78">xcb_big_requests_enable_reply</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> cookie, <a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a> **e)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9a8c4ed2d0c2ff3b946c2bb3df3447a7"></a><!-- doxytag: member="XCB_BigRequests_API::xcb_big_requests_id" ref="ga9a8c4ed2d0c2ff3b946c2bb3df3447a7" args="" -->
<a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> </td><td class="memItemRight" valign="bottom"><b>xcb_big_requests_id</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>BigRequests XCB Protocol Implementation. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga49a113890815c160da45827c3ae27a7a"></a><!-- doxytag: member="bigreq.h::XCB_BIG_REQUESTS_ENABLE" ref="ga49a113890815c160da45827c3ae27a7a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCB_BIG_REQUESTS_ENABLE   0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opcode for xcb_big_requests_enable. </p>
<p>Referenced by <a class="el" href="group__XCB__BigRequests__API.html#ga127f5654f2a302929d684367f1ba8b01">xcb_big_requests_enable()</a>, and <a class="el" href="group__XCB__BigRequests__API.html#ga5f956b4ef03cdac1e43db39eefa24613">xcb_big_requests_enable_unchecked()</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga127f5654f2a302929d684367f1ba8b01"></a><!-- doxytag: member="bigreq.h::xcb_big_requests_enable" ref="ga127f5654f2a302929d684367f1ba8b01" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> xcb_big_requests_enable </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>Delivers a request to the X 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 cookie</dd></dl>
<p>Delivers a request to the X server. </p>
<p>References <a class="el" href="group__XCB__BigRequests__API.html#ga49a113890815c160da45827c3ae27a7a">XCB_BIG_REQUESTS_ENABLE</a>.</p>
<p>Referenced by <a class="el" href="group__XCB__Core__API.html#ga365edf27111a8dd4e1d2831f652315e7">xcb_prefetch_maximum_request_length()</a>.</p>
</div>
</div>
<a class="anchor" id="ga3b29dd51a194c5168c527dc65d8b3b78"></a><!-- doxytag: member="bigreq.h::xcb_big_requests_enable_reply" ref="ga3b29dd51a194c5168c527dc65d8b3b78" args="(xcb_connection_t *c, xcb_big_requests_enable_cookie_t cookie, xcb_generic_error_t **e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__big__requests__enable__reply__t.html">xcb_big_requests_enable_reply_t</a>* xcb_big_requests_enable_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"><a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> </td>
<td class="paramname"><em>cookie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a> ** </td>
<td class="paramname"><em>e</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the reply </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">cookie</td><td>The cookie </td></tr>
<tr><td class="paramname">e</td><td>The <a class="el" href="structxcb__generic__error__t.html" title="Generic error.">xcb_generic_error_t</a> supplied</td></tr>
</table>
</dd>
</dl>
<p>Returns the reply of the request asked by</p>
<p>The parameter <code>e</code> supplied to this function must be NULL if <a class="el" href="group__XCB__BigRequests__API.html#ga5f956b4ef03cdac1e43db39eefa24613">xcb_big_requests_enable_unchecked()</a>. is used. Otherwise, it stores the error if any.</p>
<p>The returned value must be freed by the caller using free(). </p>
<p>References <a class="el" href="structxcb__big__requests__enable__cookie__t.html#a5bb70f945f01cb4c888407e36f7b54f8">xcb_big_requests_enable_cookie_t::sequence</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="ga5f956b4ef03cdac1e43db39eefa24613"></a><!-- doxytag: member="bigreq.h::xcb_big_requests_enable_unchecked" ref="ga5f956b4ef03cdac1e43db39eefa24613" args="(xcb_connection_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structxcb__big__requests__enable__cookie__t.html">xcb_big_requests_enable_cookie_t</a> xcb_big_requests_enable_unchecked </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>Delivers a request to the X 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 cookie</dd></dl>
<p>Delivers a request to the X server.</p>
<p>This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue. </p>
<p>References <a class="el" href="group__XCB__BigRequests__API.html#ga49a113890815c160da45827c3ae27a7a">XCB_BIG_REQUESTS_ENABLE</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Apr 29 2011 15:45:46 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>
