JezK
Edit File: a00239.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> <meta http-equiv="X-UA-Compatible" content="IE=11"/> <meta name="generator" content="Doxygen 1.9.4"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>FreeTDS API: src/tds/read.c File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr id="projectrow"> <td id="projectalign"> <div id="projectname">FreeTDS API </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.9.4 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ var searchBox = new SearchBox("searchBox", "search",'Search','.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */ </script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_f7308370ebb9c2ff76f3bdfe0748aabf.html">tds</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"><div class="title">read.c File Reference</div></div> </div><!--header--> <div class="contents"> <p>Grab data from TDS packets. <a href="#details">More...</a></p> <div class="textblock"><code>#include <config.h></code><br /> <code>#include <assert.h></code><br /> <code>#include <<a class="el" href="a00416_source.html">freetds/tds.h</a>></code><br /> <code>#include <freetds/iconv.h></code><br /> <code>#include <freetds/bytes.h></code><br /> <code>#include <freetds/stream.h></code><br /> <code>#include <freetds/utils/string.h></code><br /> <code>#include <freetds/checks.h></code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for read.c:</div> <div class="dyncontent"> <div class="center"><!-- SVG 0 --> </div> </div> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga676c4dee6522815b16fdc8e448e43590"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga676c4dee6522815b16fdc8e448e43590">read_and_convert</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds, <a class="el" href="a00958.html">TDSICONV</a> *char_conv, size_t *wire_size, char *outbuf, size_t outbytesleft)</td></tr> <tr class="memdesc:ga676c4dee6522815b16fdc8e448e43590"><td class="mdescLeft"> </td><td class="mdescRight">For UTF-8 and similar, <a class="el" href="a00540.html#ga87db49044919f1bc84c0ff5e9ab00304" title="Wrapper around iconv(3).">tds_iconv()</a> may encounter a partial sequence when the chunk boundary is not aligned with the character boundary. <a href="a00543.html#ga676c4dee6522815b16fdc8e448e43590">More...</a><br /></td></tr> <tr class="separator:ga676c4dee6522815b16fdc8e448e43590"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga017c427e9599c031be5c555cb32abe2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00545.html#gafddddf5bd7ad223cadee3d3bdc899954">DSTR</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga017c427e9599c031be5c555cb32abe2c">tds_dstr_get</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds, <a class="el" href="a00545.html#gafddddf5bd7ad223cadee3d3bdc899954">DSTR</a> *s, size_t len)</td></tr> <tr class="memdesc:ga017c427e9599c031be5c555cb32abe2c"><td class="mdescLeft"> </td><td class="mdescRight">Reads a string from wire and put in a DSTR. <a href="a00543.html#ga017c427e9599c031be5c555cb32abe2c">More...</a><br /></td></tr> <tr class="separator:ga017c427e9599c031be5c555cb32abe2c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0cb72d3f6943795c39db1fa692be0a58"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga0cb72d3f6943795c39db1fa692be0a58">tds_get_byte</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds)</td></tr> <tr class="memdesc:ga0cb72d3f6943795c39db1fa692be0a58"><td class="mdescLeft"> </td><td class="mdescRight">Return a single byte from the input buffer. <a href="a00543.html#ga0cb72d3f6943795c39db1fa692be0a58">More...</a><br /></td></tr> <tr class="separator:ga0cb72d3f6943795c39db1fa692be0a58"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8d214089b6e97fc0da5e0be09f216d73"><td class="memItemLeft" align="right" valign="top">TDSRET </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga8d214089b6e97fc0da5e0be09f216d73">tds_get_char_data</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds, char *row_buffer, size_t wire_size, <a class="el" href="a01150.html">TDSCOLUMN</a> *curcol)</td></tr> <tr class="memdesc:ga8d214089b6e97fc0da5e0be09f216d73"><td class="mdescLeft"> </td><td class="mdescRight">Fetch character data the wire. <a href="a00543.html#ga8d214089b6e97fc0da5e0be09f216d73">More...</a><br /></td></tr> <tr class="separator:ga8d214089b6e97fc0da5e0be09f216d73"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae777dd57e8d1bb40349d7d7d8434fddf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#gae777dd57e8d1bb40349d7d7d8434fddf">tds_get_n</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds, void *dest, size_t need)</td></tr> <tr class="memdesc:gae777dd57e8d1bb40349d7d7d8434fddf"><td class="mdescLeft"> </td><td class="mdescRight">Get N bytes from the buffer and return them in the already allocated space <br /> given to us. <a href="a00543.html#gae777dd57e8d1bb40349d7d7d8434fddf">More...</a><br /></td></tr> <tr class="separator:gae777dd57e8d1bb40349d7d7d8434fddf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga90f080e6e9448feac15dee1370d66802"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga90f080e6e9448feac15dee1370d66802">tds_get_string</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds, size_t string_len, char *dest, size_t dest_size)</td></tr> <tr class="memdesc:ga90f080e6e9448feac15dee1370d66802"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a string from the wire. <a href="a00543.html#ga90f080e6e9448feac15dee1370d66802">More...</a><br /></td></tr> <tr class="separator:ga90f080e6e9448feac15dee1370d66802"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9ac121c269e203337a48c5bf8afc48c3"><td class="memItemLeft" align="right" valign="top">TDS_UINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga9ac121c269e203337a48c5bf8afc48c3">tds_get_uint</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds)</td></tr> <tr class="memdesc:ga9ac121c269e203337a48c5bf8afc48c3"><td class="mdescLeft"> </td><td class="mdescRight">Get an int32 from the server. <a href="a00543.html#ga9ac121c269e203337a48c5bf8afc48c3">More...</a><br /></td></tr> <tr class="separator:ga9ac121c269e203337a48c5bf8afc48c3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8ab6c87318eaf15ea17a9575763f7809"><td class="memItemLeft" align="right" valign="top">TDS_UINT8 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga8ab6c87318eaf15ea17a9575763f7809">tds_get_uint8</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds)</td></tr> <tr class="memdesc:ga8ab6c87318eaf15ea17a9575763f7809"><td class="mdescLeft"> </td><td class="mdescRight">Get an uint64 from the server. <a href="a00543.html#ga8ab6c87318eaf15ea17a9575763f7809">More...</a><br /></td></tr> <tr class="separator:ga8ab6c87318eaf15ea17a9575763f7809"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad38aa5b9547817854ccba1fcc7855861"><td class="memItemLeft" align="right" valign="top"> TDS_USMALLINT </td><td class="memItemRight" valign="bottom"><b>tds_get_usmallint</b> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds)</td></tr> <tr class="memdesc:gad38aa5b9547817854ccba1fcc7855861"><td class="mdescLeft"> </td><td class="mdescRight">Get an int16 from the server. <br /></td></tr> <tr class="separator:gad38aa5b9547817854ccba1fcc7855861"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga221e98a9c8be96ec6c8547891e1b53af"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#ga221e98a9c8be96ec6c8547891e1b53af">tds_peek</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds)</td></tr> <tr class="memdesc:ga221e98a9c8be96ec6c8547891e1b53af"><td class="mdescLeft"> </td><td class="mdescRight">Reads a byte from the TDS stream without removing it. <a href="a00543.html#ga221e98a9c8be96ec6c8547891e1b53af">More...</a><br /></td></tr> <tr class="separator:ga221e98a9c8be96ec6c8547891e1b53af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad70d59fb317d098b0c9fd29dd77131a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00543.html#gad70d59fb317d098b0c9fd29dd77131a8">tds_unget_byte</a> (<a class="el" href="a01210.html">TDSSOCKET</a> *tds)</td></tr> <tr class="memdesc:gad70d59fb317d098b0c9fd29dd77131a8"><td class="mdescLeft"> </td><td class="mdescRight">Unget will always work as long as you don't call it twice in a row. <a href="a00543.html#gad70d59fb317d098b0c9fd29dd77131a8">More...</a><br /></td></tr> <tr class="separator:gad70d59fb317d098b0c9fd29dd77131a8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p >Grab data from TDS packets. </p> </div></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </small></address> </body> </html>