2020-02-17 21:17:06 +00: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&type=2" border = "0" alt = "SourceForge.net Logo" / > < / a >
2020-02-17 21:19:08 +00:00
<!-- Generated by Doxygen 1.3.9.1 -->
< div class = "qindex" > < a class = "qindex" href = "index.html" > Main Page< / a > | < a class = "qindex" href = "annotated.html" > Class List< / a > | < a class = "qindex" href = "dirs.html" > Directories< / a > | < a class = "qindex" href = "files.html" > File List< / a > | < a class = "qindex" href = "functions.html" > Class Members< / a > | < a class = "qindex" href = "globals.html" > File Members< / a > | < a class = "qindex" href = "examples.html" > Examples< / a > < / div >
< h1 > XQC_InputStream_s Struct Reference< / h1 > The < a class = "el" href = "xqc_8h.html#a6" > XQC_InputStream< / a > struct is designed to be populated by users for the purpose of streaming data into an XQC implementation.
2020-02-17 21:17:06 +00:00
< a href = "#_details" > More...< / a >
< p >
< code > #include < < a class = "el" href = "xqc_8h-source.html" > xqc.h< / a > > < / code >
< p >
< a href = "structXQC__InputStream__s-members.html" > List of all members.< / a > < table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < td > < / td > < / tr >
< tr > < td colspan = "2" > < br > < h2 > Public Attributes< / h2 > < / td > < / tr >
2020-02-17 21:19:08 +00:00
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > const char * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__InputStream__s.html#o0" > encoding< / a > < / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > The text encoding of the input data as a UTF-8 string, or 0 if unknown. < a href = "#o0" > < / a > < br > < / td > < / tr >
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > void * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__InputStream__s.html#o1" > user_data< / a > < / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Can be used for user specific purposes. < a href = "#o1" > < / a > < br > < / td > < / tr >
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > unsigned int(* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__InputStream__s.html#o2" > read< / a > )(< a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream, void *buffer, unsigned int length)< / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > The function called to read more of the input query. < a href = "#o2" > < / a > < br > < / td > < / tr >
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > void(* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__InputStream__s.html#o3" > free< / a > )(< a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream)< / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Called to free the resources associated with the XQC_InputStream. < a href = "#o3" > < / a > < br > < / td > < / tr >
2020-02-17 21:17:06 +00:00
< / table >
< hr > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
2020-02-17 21:19:08 +00:00
The < a class = "el" href = "xqc_8h.html#a6" > 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 >
< a class = "anchor" name = "o0" doxytag = "XQC_InputStream_s::encoding" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > const char* < a class = "el" href = "structXQC__InputStream__s.html#o0" > XQC_InputStream_s::encoding< / a > < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
The text encoding of the input data as a UTF-8 string, or 0 if unknown.
< p >
The value of the string should conform to the < code > EncName< / code > grammar production as specified in XML 1.0:< p >
2020-02-17 21:19:08 +00:00
< a href = "http://www.w3.org/TR/REC-xml/#NT-EncName" > http://www.w3.org/TR/REC-xml/#NT-EncName< / a > < / td >
< / tr >
< / table >
< a class = "anchor" name = "o3" doxytag = "XQC_InputStream_s::free" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > void(* < a class = "el" href = "structXQC__InputStream__s.html#o3" > XQC_InputStream_s::free< / a > )(< a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream) < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
Called to free the resources associated with the XQC_InputStream.
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > stream< / em > < / td > < td > The XQC_InputStream that this function pointer is a member of< / td > < / tr >
< / table >
< / dl >
< / td >
< / tr >
< / table >
< a class = "anchor" name = "o2" doxytag = "XQC_InputStream_s::read" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > unsigned int(* < a class = "el" href = "structXQC__InputStream__s.html#o2" > XQC_InputStream_s::read< / a > )(< a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream, void *buffer, unsigned int length) < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
The function called to read more of the input query.
< p >
The function should read the next chunk of input into the buffer provided, returning the length of the data read.< p >
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > stream< / em > < / td > < td > The XQC_InputStream that this function pointer is a member of < / td > < / tr >
< tr > < td valign = "top" > < tt > [out]< / tt > < / td > < td valign = "top" > < em > buffer< / em > < / td > < td > The buffer to read the data into < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > length< / em > < / td > < td > The length of the buffer< / td > < / tr >
< / table >
< / dl >
2020-02-17 21:19:08 +00:00
< dl compact > < 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 >
< / td >
< / tr >
< / table >
< a class = "anchor" name = "o1" doxytag = "XQC_InputStream_s::user_data" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > void* < a class = "el" href = "structXQC__InputStream__s.html#o1" > XQC_InputStream_s::user_data< / a > < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
Can be used for user specific purposes.
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
2020-02-17 21:17:06 +00:00
< 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 > < / ul >
2020-02-17 21:19:08 +00:00
< hr size = "1" > < address style = "align: right;" > < small > Generated on Fri Sep 25 06:55:57 2009 for XQilla XQC API by
2020-02-17 21:17:06 +00:00
< a href = "http://www.doxygen.org/index.html" >
2020-02-17 21:19:08 +00:00
< img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.3.9.1 < / small > < / address >
2020-02-17 21:17:06 +00:00
< / body >
< / html >
