JezK
Edit File: a01174.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: tds_cursor Struct 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><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Public Attributes</a> | <a href="a01171.html">List of all members</a> </div> <div class="headertitle"><div class="title">tds_cursor Struct Reference</div></div> </div><!--header--> <div class="contents"> <p>Holds informations about a cursor. <a href="a01174.html#details">More...</a></p> <p><code>#include <<a class="el" href="a00416_source.html">tds.h</a>></code></p> <div class="dynheader"> Collaboration diagram for tds_cursor:</div> <div class="dyncontent"> <div class="center"><!-- SVG 0 --> </div> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a89b58ec7ba1c1c5c28080e3653a9fa91"><td class="memItemLeft" align="right" valign="top"><a id="a89b58ec7ba1c1c5c28080e3653a9fa91" name="a89b58ec7ba1c1c5c28080e3653a9fa91"></a> TDS_INT </td><td class="memItemRight" valign="bottom"><b>concurrency</b></td></tr> <tr class="separator:a89b58ec7ba1c1c5c28080e3653a9fa91"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b7d4cedf0cc7f890133f021d18af58c"><td class="memItemLeft" align="right" valign="top"><a id="a7b7d4cedf0cc7f890133f021d18af58c" name="a7b7d4cedf0cc7f890133f021d18af58c"></a> TDS_INT </td><td class="memItemRight" valign="bottom"><b>cursor_id</b></td></tr> <tr class="memdesc:a7b7d4cedf0cc7f890133f021d18af58c"><td class="mdescLeft"> </td><td class="mdescRight">cursor id returned by the server after cursor declare <br /></td></tr> <tr class="separator:a7b7d4cedf0cc7f890133f021d18af58c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afd459125b5c4d4ccbf77a7d6ca8a4aaa"><td class="memItemLeft" align="right" valign="top"><a id="afd459125b5c4d4ccbf77a7d6ca8a4aaa" name="afd459125b5c4d4ccbf77a7d6ca8a4aaa"></a> char * </td><td class="memItemRight" valign="bottom"><b>cursor_name</b></td></tr> <tr class="memdesc:afd459125b5c4d4ccbf77a7d6ca8a4aaa"><td class="mdescLeft"> </td><td class="mdescRight">name of the cursor <br /></td></tr> <tr class="separator:afd459125b5c4d4ccbf77a7d6ca8a4aaa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7ec745adff5b2391e609e836c9f010cd"><td class="memItemLeft" align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a01174.html#a7ec745adff5b2391e609e836c9f010cd">cursor_rows</a></td></tr> <tr class="memdesc:a7ec745adff5b2391e609e836c9f010cd"><td class="mdescLeft"> </td><td class="mdescRight">< number of updatable columns <a href="a01174.html#a7ec745adff5b2391e609e836c9f010cd">More...</a><br /></td></tr> <tr class="separator:a7ec745adff5b2391e609e836c9f010cd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a411e76370c635dfabe9b5941cdd3180f"><td class="memItemLeft" align="right" valign="top"><a id="a411e76370c635dfabe9b5941cdd3180f" name="a411e76370c635dfabe9b5941cdd3180f"></a> bool </td><td class="memItemRight" valign="bottom"><b>defer_close</b></td></tr> <tr class="memdesc:a411e76370c635dfabe9b5941cdd3180f"><td class="mdescLeft"> </td><td class="mdescRight">true if cursor was marker to be closed when connection is idle <br /></td></tr> <tr class="separator:a411e76370c635dfabe9b5941cdd3180f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8743877d9147d83ef0ae64e04c8a46fb"><td class="memItemLeft" align="right" valign="top"><a id="a8743877d9147d83ef0ae64e04c8a46fb" name="a8743877d9147d83ef0ae64e04c8a46fb"></a> struct <a class="el" href="a01174.html">tds_cursor</a> * </td><td class="memItemRight" valign="bottom"><b>next</b></td></tr> <tr class="memdesc:a8743877d9147d83ef0ae64e04c8a46fb"><td class="mdescLeft"> </td><td class="mdescRight">next in linked list, keep first <br /></td></tr> <tr class="separator:a8743877d9147d83ef0ae64e04c8a46fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1be9f69f84a6d83ce86380c33a2bf9f8"><td class="memItemLeft" align="right" valign="top"><a id="a1be9f69f84a6d83ce86380c33a2bf9f8" name="a1be9f69f84a6d83ce86380c33a2bf9f8"></a> TDS_TINYINT </td><td class="memItemRight" valign="bottom"><b>options</b></td></tr> <tr class="memdesc:a1be9f69f84a6d83ce86380c33a2bf9f8"><td class="mdescLeft"> </td><td class="mdescRight">read only|updatable TODO use it <br /></td></tr> <tr class="separator:a1be9f69f84a6d83ce86380c33a2bf9f8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeec2a01af48693b8b22449f15725d502"><td class="memItemLeft" align="right" valign="top"><a id="aeec2a01af48693b8b22449f15725d502" name="aeec2a01af48693b8b22449f15725d502"></a> char * </td><td class="memItemRight" valign="bottom"><b>query</b></td></tr> <tr class="memdesc:aeec2a01af48693b8b22449f15725d502"><td class="mdescLeft"> </td><td class="mdescRight">SQL query. <br /></td></tr> <tr class="separator:aeec2a01af48693b8b22449f15725d502"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a692ccceff71d836df0d084ec26123c2d"><td class="memItemLeft" align="right" valign="top"><a id="a692ccceff71d836df0d084ec26123c2d" name="a692ccceff71d836df0d084ec26123c2d"></a> TDS_INT </td><td class="memItemRight" valign="bottom"><b>ref_count</b></td></tr> <tr class="memdesc:a692ccceff71d836df0d084ec26123c2d"><td class="mdescLeft"> </td><td class="mdescRight">reference counter so client can retain safely a pointer <br /></td></tr> <tr class="separator:a692ccceff71d836df0d084ec26123c2d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a697b6a9cbff3e95cea5a43a8e190fba6"><td class="memItemLeft" align="right" valign="top"><a id="a697b6a9cbff3e95cea5a43a8e190fba6" name="a697b6a9cbff3e95cea5a43a8e190fba6"></a> <a class="el" href="a00416.html#a1efbb2f3844cb2ea89af03721ac67277">TDSRESULTINFO</a> * </td><td class="memItemRight" valign="bottom"><b>res_info</b></td></tr> <tr class="separator:a697b6a9cbff3e95cea5a43a8e190fba6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acb18bc0e527cf90c06cbe27d1b4fb04b"><td class="memItemLeft" align="right" valign="top"><a id="acb18bc0e527cf90c06cbe27d1b4fb04b" name="acb18bc0e527cf90c06cbe27d1b4fb04b"></a> TDS_USMALLINT </td><td class="memItemRight" valign="bottom"><b>srv_status</b></td></tr> <tr class="separator:acb18bc0e527cf90c06cbe27d1b4fb04b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab5d6a587ac5780f001d383d4b874852f"><td class="memItemLeft" align="right" valign="top"><a id="ab5d6a587ac5780f001d383d4b874852f" name="ab5d6a587ac5780f001d383d4b874852f"></a> <a class="el" href="a01170.html">TDS_CURSOR_STATUS</a> </td><td class="memItemRight" valign="bottom"><b>status</b></td></tr> <tr class="memdesc:ab5d6a587ac5780f001d383d4b874852f"><td class="mdescLeft"> </td><td class="mdescRight">cursor parameter <br /></td></tr> <tr class="separator:ab5d6a587ac5780f001d383d4b874852f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a889aafdde1d57c9be0585326022831f0"><td class="memItemLeft" align="right" valign="top"><a id="a889aafdde1d57c9be0585326022831f0" name="a889aafdde1d57c9be0585326022831f0"></a> TDS_INT </td><td class="memItemRight" valign="bottom"><b>type</b></td></tr> <tr class="memdesc:a889aafdde1d57c9be0585326022831f0"><td class="mdescLeft"> </td><td class="mdescRight">row fetched from this cursor <br /></td></tr> <tr class="separator:a889aafdde1d57c9be0585326022831f0"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p >Holds informations about a cursor. </p> </div><h2 class="groupheader">Member Data Documentation</h2> <a id="a7ec745adff5b2391e609e836c9f010cd" name="a7ec745adff5b2391e609e836c9f010cd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7ec745adff5b2391e609e836c9f010cd">◆ </a></span>cursor_rows</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TDS_INT tds_cursor::cursor_rows</td> </tr> </table> </div><div class="memdoc"> <p>< number of updatable columns </p> <p >< updatable column list number of cursor rows to fetch </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li>include/freetds/<a class="el" href="a00416_source.html">tds.h</a></li> </ul> </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>