JezK
Edit File: a00377_source.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: include/freetds/checks.h Source File</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f46f2c05841018b6ef8dbd3316ddb41a.html">freetds</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"><div class="title">checks.h</div></div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/* FreeTDS - Library of routines accessing Sybase and Microsoft databases</span></div> <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (C) 2004 Frediano Ziglio</span></div> <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div> <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * This library is free software; you can redistribute it and/or</span></div> <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * modify it under the terms of the GNU Library General Public</span></div> <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * License as published by the Free Software Foundation; either</span></div> <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * version 2 of the License, or (at your option) any later version.</span></div> <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div> <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * This library is distributed in the hope that it will be useful,</span></div> <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div> <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Library General Public License for more details.</span></div> <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> *</span></div> <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * You should have received a copy of the GNU Library General Public</span></div> <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * License along with this library; if not, write to the</span></div> <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330,</span></div> <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * Boston, MA 02111-1307, USA.</span></div> <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef TDS_CHECKS_H</span></div> <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define TDS_CHECKS_H</span></div> <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <freetds/pushvis.h></span></div> <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#if ENABLE_EXTRA_CHECKS</span></div> <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#define CHECK_STRUCT_EXTRA(func,s) func(s)</span></div> <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#else</span></div> <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#define CHECK_STRUCT_EXTRA(func,s)</span></div> <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#endif</span></div> <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#define CHECK_TDS_EXTRA(tds) CHECK_STRUCT_EXTRA(tds_check_tds_extra,tds)</span></div> <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#define CHECK_CONTEXT_EXTRA(ctx) CHECK_STRUCT_EXTRA(tds_check_context_extra,ctx)</span></div> <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#define CHECK_TDSENV_EXTRA(env) CHECK_STRUCT_EXTRA(tds_check_env_extra,env)</span></div> <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#define CHECK_COLUMN_EXTRA(column) CHECK_STRUCT_EXTRA(tds_check_column_extra,column)</span></div> <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#define CHECK_RESULTINFO_EXTRA(res_info) CHECK_STRUCT_EXTRA(tds_check_resultinfo_extra,res_info)</span></div> <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#define CHECK_PARAMINFO_EXTRA(res_info) CHECK_STRUCT_EXTRA(tds_check_resultinfo_extra,res_info)</span></div> <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#define CHECK_CURSOR_EXTRA(cursor) CHECK_STRUCT_EXTRA(tds_check_cursor_extra,cursor)</span></div> <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#define CHECK_DYNAMIC_EXTRA(dynamic) CHECK_STRUCT_EXTRA(tds_check_dynamic_extra,dynamic)</span></div> <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#define CHECK_FREEZE_EXTRA(freeze) CHECK_STRUCT_EXTRA(tds_check_freeze_extra,freeze)</span></div> <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#define CHECK_CONN_EXTRA(conn)</span></div> <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#if ENABLE_EXTRA_CHECKS</span></div> <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keywordtype">void</span> tds_check_tds_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01210.html">TDSSOCKET</a> * tds);</div> <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keywordtype">void</span> tds_check_context_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01190.html">TDSCONTEXT</a> * ctx);</div> <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keywordtype">void</span> tds_check_env_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01178.html">TDSENV</a> * env);</div> <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keywordtype">void</span> tds_check_column_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01150.html">TDSCOLUMN</a> * column);</div> <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keywordtype">void</span> tds_check_resultinfo_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01158.html">TDSRESULTINFO</a> * res_info);</div> <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keywordtype">void</span> tds_check_cursor_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01174.html">TDSCURSOR</a> * cursor);</div> <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keywordtype">void</span> tds_check_dynamic_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01182.html">TDSDYNAMIC</a> * dynamic);</div> <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keywordtype">void</span> tds_check_freeze_extra(<span class="keyword">const</span> <a class="code hl_struct" href="a01218.html">TDSFREEZE</a> * freeze);</div> <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif</span></div> <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#if defined(HAVE_VALGRIND_MEMCHECK_H) && ENABLE_EXTRA_CHECKS</span></div> <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor"># include <valgrind/memcheck.h></span></div> <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor"># define TDS_MARK_UNDEFINED(ptr, len) VALGRIND_MAKE_MEM_UNDEFINED(ptr, len)</span></div> <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#else</span></div> <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor"># define TDS_MARK_UNDEFINED(ptr, len) do {} while(0)</span></div> <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#endif</span></div> <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#if ENABLE_EXTRA_CHECKS</span></div> <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keywordtype">void</span> tds_extra_assert_check(<span class="keyword">const</span> <span class="keywordtype">char</span> *fn, <span class="keywordtype">int</span> line, <span class="keywordtype">int</span> cond, <span class="keyword">const</span> <span class="keywordtype">char</span> *cond_str);</div> <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor"># define tds_extra_assert(cond) \</span></div> <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor"> tds_extra_assert_check(__FILE__, __LINE__, cond, #cond)</span></div> <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#else</span></div> <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor"># define tds_extra_assert(cond) do { } while(0)</span></div> <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#endif</span></div> <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#include <freetds/popvis.h></span></div> <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="preprocessor">#endif </span><span class="comment">/* TDS_CHECKS_H */</span><span class="preprocessor"></span></div> <div class="ttc" id="aa01150_html"><div class="ttname"><a href="a01150.html">tds_column</a></div><div class="ttdoc">Metadata about columns in regular and compute rows.</div><div class="ttdef"><b>Definition:</b> tds.h:689</div></div> <div class="ttc" id="aa01158_html"><div class="ttname"><a href="a01158.html">tds_result_info</a></div><div class="ttdoc">Hold information for any results.</div><div class="ttdef"><b>Definition:</b> tds.h:769</div></div> <div class="ttc" id="aa01174_html"><div class="ttname"><a href="a01174.html">tds_cursor</a></div><div class="ttdoc">Holds informations about a cursor.</div><div class="ttdef"><b>Definition:</b> tds.h:937</div></div> <div class="ttc" id="aa01178_html"><div class="ttname"><a href="a01178.html">tds_env</a></div><div class="ttdoc">Current environment as reported by the server.</div><div class="ttdef"><b>Definition:</b> tds.h:963</div></div> <div class="ttc" id="aa01182_html"><div class="ttname"><a href="a01182.html">tds_dynamic</a></div><div class="ttdoc">Holds information for a dynamic (also called prepared) query.</div><div class="ttdef"><b>Definition:</b> tds.h:977</div></div> <div class="ttc" id="aa01190_html"><div class="ttname"><a href="a01190.html">tds_context</a></div><div class="ttdef"><b>Definition:</b> tds.h:1029</div></div> <div class="ttc" id="aa01210_html"><div class="ttname"><a href="a01210.html">tds_socket</a></div><div class="ttdoc">Information for a server connection.</div><div class="ttdef"><b>Definition:</b> tds.h:1163</div></div> <div class="ttc" id="aa01218_html"><div class="ttname"><a href="a01218.html">tds_freeze</a></div><div class="ttdef"><b>Definition:</b> tds.h:1571</div></div> </div><!-- fragment --></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>