mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/xqc-api/structXQC__InputStream__s.html

135 lines
7.9 KiB
HTML
Raw Normal View History

v2.2.0
2020-02-17 22:17:06 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla XQC API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
v2.3.1
2020-02-17 22:23:16 +01:00
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
v2.2.3
2020-02-17 22:19:57 +01:00
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
v2.3.1
2020-02-17 22:23:16 +01:00
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
v2.2.3
2020-02-17 22:19:57 +01:00
</ul>
</div>
</div>
<div class="contents">
v2.3.1
2020-02-17 22:23:16 +01:00
<h1>XQC_InputStream_s Struct Reference</h1><!-- doxytag: class="XQC_InputStream_s" -->
v2.2.3
2020-02-17 22:19:57 +01:00
<p>The <a class="el" href="xqc_8h.html#aa2362b43cca7bd9527ed4477a5481528">XQC_InputStream</a> struct is designed to be populated by users for the purpose of streaming data into an XQC implementation.
<a href="#_details">More...</a></p>
v2.2.0
2020-02-17 22:17:06 +01:00
v2.2.3
2020-02-17 22:19:57 +01:00
<p><code>#include &lt;<a class="el" href="xqc_8h_source.html">xqc.h</a>&gt;</code></p>
v2.2.0
2020-02-17 22:17:06 +01:00
v2.2.3
2020-02-17 22:19:57 +01:00
<p><a href="structXQC__InputStream__s-members.html">List of all members.</a></p>
v2.3.1
2020-02-17 22:23:16 +01:00
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__InputStream__s.html#aa4d231151fe0fe6ddc189d84f8f1197b">encoding</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The text encoding of the input data as a UTF-8 string, or 0 if unknown. <a href="#aa4d231151fe0fe6ddc189d84f8f1197b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__InputStream__s.html#a72b22742c94ee0efe5b5de0e63b7ae89">user_data</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Can be used for user specific purposes. <a href="#a72b22742c94ee0efe5b5de0e63b7ae89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__InputStream__s.html#a9dd7b49bdfaf09c4070c43aa5a0e0c66">read</a> )(<a class="el" href="structXQC__InputStream__s.html">XQC_InputStream</a> *stream, void *buffer, unsigned int length)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The function called to read more of the input query. <a href="#a9dd7b49bdfaf09c4070c43aa5a0e0c66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__InputStream__s.html#a48aaf721537dfba8945afb24511030ac">free</a> )(<a class="el" href="structXQC__InputStream__s.html">XQC_InputStream</a> *stream)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to free the resources associated with the XQC_InputStream. <a href="#a48aaf721537dfba8945afb24511030ac"></a><br/></td></tr>
v2.2.0
2020-02-17 22:17:06 +01:00
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
v2.3.1
2020-02-17 22:23:16 +01:00
<p>The <a class="el" href="xqc_8h.html#aa2362b43cca7bd9527ed4477a5481528">XQC_InputStream</a> struct is designed to be populated by users for the purpose of streaming data into an XQC implementation. </p>
<hr/><h2>Member Data Documentation</h2>
v2.2.3
2020-02-17 22:19:57 +01:00
<a class="anchor" id="aa4d231151fe0fe6ddc189d84f8f1197b"></a><!-- doxytag: member="XQC_InputStream_s::encoding" ref="aa4d231151fe0fe6ddc189d84f8f1197b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
v2.2.0
2020-02-17 22:17:06 +01:00
<tr>
v2.2.3
2020-02-17 22:19:57 +01:00
<td class="memname">const char* <a class="el" href="structXQC__InputStream__s.html#aa4d231151fe0fe6ddc189d84f8f1197b">XQC_InputStream_s::encoding</a></td>
v2.2.0
2020-02-17 22:17:06 +01:00
</tr>
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
v2.2.0
2020-02-17 22:17:06 +01:00
v2.2.3
2020-02-17 22:19:57 +01:00
<p>The text encoding of the input data as a UTF-8 string, or 0 if unknown. </p>
<p>The value of the string should conform to the <code>EncName</code> grammar production as specified in XML 1.0:</p>
<p><a href="http://www.w3.org/TR/REC-xml/#NT-EncName">http://www.w3.org/TR/REC-xml/#NT-EncName</a> </p>
</div>
</div>
<a class="anchor" id="a48aaf721537dfba8945afb24511030ac"></a><!-- doxytag: member="XQC_InputStream_s::free" ref="a48aaf721537dfba8945afb24511030ac" args=")(XQC_InputStream *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
v2.2.0
2020-02-17 22:17:06 +01:00
<tr>
v2.2.3
2020-02-17 22:19:57 +01:00
<td class="memname">void(* <a class="el" href="structXQC__InputStream__s.html#a48aaf721537dfba8945afb24511030ac">XQC_InputStream_s::free</a>)(<a class="el" href="structXQC__InputStream__s.html">XQC_InputStream</a> *stream)</td>
v2.2.0
2020-02-17 22:17:06 +01:00
</tr>
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
v2.2.0
2020-02-17 22:17:06 +01:00
v2.2.3
2020-02-17 22:19:57 +01:00
<p>Called to free the resources associated with the XQC_InputStream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
v2.3.1
2020-02-17 22:23:16 +01:00
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The XQC_InputStream that this function pointer is a member of </td></tr>
v2.2.2
2020-02-17 22:19:08 +01:00
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
</dd>
v2.2.2
2020-02-17 22:19:08 +01:00
</dl>
v2.2.3
2020-02-17 22:19:57 +01:00
</div>
</div>
<a class="anchor" id="a9dd7b49bdfaf09c4070c43aa5a0e0c66"></a><!-- doxytag: member="XQC_InputStream_s::read" ref="a9dd7b49bdfaf09c4070c43aa5a0e0c66" args=")(XQC_InputStream *stream, void *buffer, unsigned int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
v2.2.0
2020-02-17 22:17:06 +01:00
<tr>
v2.2.3
2020-02-17 22:19:57 +01:00
<td class="memname">unsigned int(* <a class="el" href="structXQC__InputStream__s.html#a9dd7b49bdfaf09c4070c43aa5a0e0c66">XQC_InputStream_s::read</a>)(<a class="el" href="structXQC__InputStream__s.html">XQC_InputStream</a> *stream, void *buffer, unsigned int length)</td>
v2.2.0
2020-02-17 22:17:06 +01:00
</tr>
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
v2.2.0
2020-02-17 22:17:06 +01:00
v2.2.3
2020-02-17 22:19:57 +01:00
<p>The function called to read more of the input query. </p>
<p>The function should read the next chunk of input into the buffer provided, returning the length of the data read.</p>
<dl><dt><b>Parameters:</b></dt><dd>
v2.3.1
2020-02-17 22:23:16 +01:00
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The XQC_InputStream that this function pointer is a member of </td></tr>
<tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>buffer</em>&nbsp;</td><td>The buffer to read the data into </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The length of the buffer</td></tr>
v2.2.0
2020-02-17 22:17:06 +01:00
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
</dd>
v2.2.0
2020-02-17 22:17:06 +01:00
</dl>
v2.2.3
2020-02-17 22:19:57 +01:00
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes read - this will be less than length if the end of the input is reached</dd></dl>
</div>
</div>
<a class="anchor" id="a72b22742c94ee0efe5b5de0e63b7ae89"></a><!-- doxytag: member="XQC_InputStream_s::user_data" ref="a72b22742c94ee0efe5b5de0e63b7ae89" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
v2.2.0
2020-02-17 22:17:06 +01:00
<tr>
v2.2.3
2020-02-17 22:19:57 +01:00
<td class="memname">void* <a class="el" href="structXQC__InputStream__s.html#a72b22742c94ee0efe5b5de0e63b7ae89">XQC_InputStream_s::user_data</a></td>
v2.2.0
2020-02-17 22:17:06 +01:00
</tr>
</table>
v2.2.3
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
v2.2.0
2020-02-17 22:17:06 +01:00
v2.2.3
2020-02-17 22:19:57 +01:00
<p>Can be used for user specific purposes. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xqc_8h_source.html">xqc.h</a></li>
</ul>
</div>
v2.3.3
2020-02-17 22:24:17 +01:00
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla XQC API by&nbsp;
v2.2.0
2020-02-17 22:17:06 +01:00
<a href="http://www.doxygen.org/index.html">
v2.3.1
2020-02-17 22:23:16 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
v2.2.0
2020-02-17 22:17:06 +01:00
</body>
</html>
Reference in a new issue Copy permalink