<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeTDS API: include/freetds/string.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FreeTDS API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_000000.html">include</a></li><li class="navelem"><a class="el" href="dir_000001.html">freetds</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">string.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a 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 name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Brian Bruns</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a 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 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 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 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 name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a 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 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 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Library General Public License for more details.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Boston, MA 02111-1307, USA.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef _tdsstring_h_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _tdsstring_h_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <freetds/pushvis.h></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="a01073.html">tds_dstr</a> <a class="code" href="a00535.html#ga676fd3c5c489584d09c89d66c7a0af2d">tds_str_empty</a>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="a00535.html#ga581a03a4de6c926c57b4a75a11214df4"> 37</a></span> <span class="preprocessor">#define DSTR_INITIALIZER ((struct tds_dstr*) &tds_str_empty)</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="a00535.html#ga6c0aba5c6da921898768e7f6cf177ca7"> 41</a></span> <a class="code" href="a00535.html#ga6c0aba5c6da921898768e7f6cf177ca7">tds_dstr_init</a>(<a class="code" href="a01073.html">DSTR</a> * s)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  *(s) = <a class="code" href="a00535.html#ga581a03a4de6c926c57b4a75a11214df4">DSTR_INITIALIZER</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="a00535.html#gae6d3d12bd1f5f0c56df934a377c245d3"> 48</a></span> <a class="code" href="a00535.html#gae6d3d12bd1f5f0c56df934a377c245d3">tds_dstr_isempty</a>(<a class="code" href="a01073.html">DSTR</a> * s)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> (*s)->dstr_size == 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">char</span> *</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00535.html#ga8fa35e3ff06ef0b7d0d642cf50282ab8"> 59</a></span> <a class="code" href="a00535.html#ga8fa35e3ff06ef0b7d0d642cf50282ab8">tds_dstr_buf</a>(<a class="code" href="a01073.html">DSTR</a> * s)</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> (*s)->dstr_s;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="a00535.html#ga3340b488ed37845018e34572450e64c6"> 66</a></span> <a class="code" href="a00535.html#ga3340b488ed37845018e34572450e64c6">tds_dstr_cstr</a>(<a class="code" href="a01073.html">DSTR</a> * s)</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> (*s)->dstr_s;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="a00535.html#gaf0e232f3c35f2d8b43486e8708f7a8fc"> 73</a></span> <a class="code" href="a00535.html#gaf0e232f3c35f2d8b43486e8708f7a8fc">tds_dstr_len</a>(<a class="code" href="a01073.html">DSTR</a> * s)</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> (*s)->dstr_size;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a00535.html#ga42d67780bd4fd442915780d4815fc743"> 79</a></span> <span class="preprocessor">#define tds_dstr_empty(s) \</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"> tds_dstr_free(s)</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> <a class="code" href="a00535.html#ga339ba30216e2bd5bd076aa9dcd26f3c4">tds_dstr_zero</a>(<a class="code" href="a01073.html">DSTR</a> * s);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> <a class="code" href="a00535.html#gaccd1c1c8ff938813578123963212388c">tds_dstr_free</a>(<a class="code" href="a01073.html">DSTR</a> * s);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="a01073.html">DSTR</a>* <a class="code" href="a00535.html#ga4e6d9fa6f9b9551a5a3390e10a5322e6">tds_dstr_dup</a>(<a class="code" href="a01073.html">DSTR</a> * s, <span class="keyword">const</span> <a class="code" href="a01073.html">DSTR</a> * src) TDS_WUR;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <a class="code" href="a01073.html">DSTR</a>* <a class="code" href="a00535.html#gad96366d9fa93bfc283cef1299fbe97ab">tds_dstr_copy</a>(<a class="code" href="a01073.html">DSTR</a> * s, <span class="keyword">const</span> <span class="keywordtype">char</span> *src) TDS_WUR;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <a class="code" href="a01073.html">DSTR</a>* <a class="code" href="a00535.html#ga656718f240d7403f986ae887d84a6ca1">tds_dstr_copyn</a>(<a class="code" href="a01073.html">DSTR</a> * s, <span class="keyword">const</span> <span class="keywordtype">char</span> *src, <span class="keywordtype">size_t</span> length) TDS_WUR;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <a class="code" href="a01073.html">DSTR</a>* <a class="code" href="a00535.html#gab78cc59b110df2817b00f9bed74c6ff1">tds_dstr_set</a>(<a class="code" href="a01073.html">DSTR</a> * s, <span class="keywordtype">char</span> *src) TDS_WUR;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <a class="code" href="a01073.html">DSTR</a>* <a class="code" href="a00535.html#ga0cd7863ba7c2d2da4a193234472a3d14">tds_dstr_setlen</a>(<a class="code" href="a01073.html">DSTR</a> *s, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <a class="code" href="a01073.html">DSTR</a>* <a class="code" href="a00535.html#ga6aa14b8b717b51afcfb65bd55143689d">tds_dstr_alloc</a>(<a class="code" href="a01073.html">DSTR</a> *s, <span class="keywordtype">size_t</span> length) TDS_WUR;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#include <freetds/popvis.h></span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif </span><span class="comment">/* _tdsstring_h_ */</span><span class="preprocessor"></span></div><div class="ttc" id="a00535_html_gab78cc59b110df2817b00f9bed74c6ff1"><div class="ttname"><a href="a00535.html#gab78cc59b110df2817b00f9bed74c6ff1">tds_dstr_set</a></div><div class="ttdeci">DSTR * tds_dstr_set(DSTR *s, char *src)</div><div class="ttdoc">set a string from another buffer. </div><div class="ttdef"><b>Definition:</b> tdsstring.c:108</div></div>
<div class="ttc" id="a01073_html"><div class="ttname"><a href="a01073.html">tds_dstr</a></div><div class="ttdoc">Structure to hold a string. </div><div class="ttdef"><b>Definition:</b> tds.h:94</div></div>
<div class="ttc" id="a00535_html_gae6d3d12bd1f5f0c56df934a377c245d3"><div class="ttname"><a href="a00535.html#gae6d3d12bd1f5f0c56df934a377c245d3">tds_dstr_isempty</a></div><div class="ttdeci">static int tds_dstr_isempty(DSTR *s)</div><div class="ttdoc">test if string is empty </div><div class="ttdef"><b>Definition:</b> string.h:48</div></div>
<div class="ttc" id="a00535_html_ga3340b488ed37845018e34572450e64c6"><div class="ttname"><a href="a00535.html#ga3340b488ed37845018e34572450e64c6">tds_dstr_cstr</a></div><div class="ttdeci">static const char * tds_dstr_cstr(DSTR *s)</div><div class="ttdoc">Returns a C version (NUL terminated string) of dstr. </div><div class="ttdef"><b>Definition:</b> string.h:66</div></div>
<div class="ttc" id="a00535_html_ga4e6d9fa6f9b9551a5a3390e10a5322e6"><div class="ttname"><a href="a00535.html#ga4e6d9fa6f9b9551a5a3390e10a5322e6">tds_dstr_dup</a></div><div class="ttdeci">DSTR * tds_dstr_dup(DSTR *s, const DSTR *src)</div><div class="ttdoc">Duplicate a string from another dynamic string. </div><div class="ttdef"><b>Definition:</b> tdsstring.c:135</div></div>
<div class="ttc" id="a00535_html_gad96366d9fa93bfc283cef1299fbe97ab"><div class="ttname"><a href="a00535.html#gad96366d9fa93bfc283cef1299fbe97ab">tds_dstr_copy</a></div><div class="ttdeci">DSTR * tds_dstr_copy(DSTR *s, const char *src)</div><div class="ttdoc">copy a string from another </div><div class="ttdef"><b>Definition:</b> tdsstring.c:123</div></div>
<div class="ttc" id="a00535_html_ga581a03a4de6c926c57b4a75a11214df4"><div class="ttname"><a href="a00535.html#ga581a03a4de6c926c57b4a75a11214df4">DSTR_INITIALIZER</a></div><div class="ttdeci">#define DSTR_INITIALIZER</div><div class="ttdoc">Initializer, used to initialize string like in the following example. </div><div class="ttdef"><b>Definition:</b> string.h:37</div></div>
<div class="ttc" id="a00535_html_ga6c0aba5c6da921898768e7f6cf177ca7"><div class="ttname"><a href="a00535.html#ga6c0aba5c6da921898768e7f6cf177ca7">tds_dstr_init</a></div><div class="ttdeci">static void tds_dstr_init(DSTR *s)</div><div class="ttdoc">init a string with empty </div><div class="ttdef"><b>Definition:</b> string.h:41</div></div>
<div class="ttc" id="a00535_html_ga676fd3c5c489584d09c89d66c7a0af2d"><div class="ttname"><a href="a00535.html#ga676fd3c5c489584d09c89d66c7a0af2d">tds_str_empty</a></div><div class="ttdeci">const struct tds_dstr tds_str_empty</div><div class="ttdoc">Internal representation for an empty string. </div><div class="ttdef"><b>Definition:</b> tdsstring.c:46</div></div>
<div class="ttc" id="a00535_html_gaccd1c1c8ff938813578123963212388c"><div class="ttname"><a href="a00535.html#gaccd1c1c8ff938813578123963212388c">tds_dstr_free</a></div><div class="ttdeci">void tds_dstr_free(DSTR *s)</div><div class="ttdoc">free string </div><div class="ttdef"><b>Definition:</b> tdsstring.c:63</div></div>
<div class="ttc" id="a00535_html_ga8fa35e3ff06ef0b7d0d642cf50282ab8"><div class="ttname"><a href="a00535.html#ga8fa35e3ff06ef0b7d0d642cf50282ab8">tds_dstr_buf</a></div><div class="ttdeci">static char * tds_dstr_buf(DSTR *s)</div><div class="ttdoc">Returns a buffer to edit the string. </div><div class="ttdef"><b>Definition:</b> string.h:59</div></div>
<div class="ttc" id="a00535_html_ga339ba30216e2bd5bd076aa9dcd26f3c4"><div class="ttname"><a href="a00535.html#ga339ba30216e2bd5bd076aa9dcd26f3c4">tds_dstr_zero</a></div><div class="ttdeci">void tds_dstr_zero(DSTR *s)</div><div class="ttdoc">clear all string filling with zeroes (mainly for security reason) </div><div class="ttdef"><b>Definition:</b> tdsstring.c:56</div></div>
<div class="ttc" id="a00535_html_ga656718f240d7403f986ae887d84a6ca1"><div class="ttname"><a href="a00535.html#ga656718f240d7403f986ae887d84a6ca1">tds_dstr_copyn</a></div><div class="ttdeci">DSTR * tds_dstr_copyn(DSTR *s, const char *src, size_t length)</div><div class="ttdoc">Set string to a given buffer of characters. </div><div class="ttdef"><b>Definition:</b> tdsstring.c:78</div></div>
<div class="ttc" id="a00535_html_gaf0e232f3c35f2d8b43486e8708f7a8fc"><div class="ttname"><a href="a00535.html#gaf0e232f3c35f2d8b43486e8708f7a8fc">tds_dstr_len</a></div><div class="ttdeci">static size_t tds_dstr_len(DSTR *s)</div><div class="ttdoc">Returns the length of the string in bytes. </div><div class="ttdef"><b>Definition:</b> string.h:73</div></div>
<div class="ttc" id="a00535_html_ga0cd7863ba7c2d2da4a193234472a3d14"><div class="ttname"><a href="a00535.html#ga0cd7863ba7c2d2da4a193234472a3d14">tds_dstr_setlen</a></div><div class="ttdeci">DSTR * tds_dstr_setlen(DSTR *s, size_t length)</div><div class="ttdoc">limit length of string, MUST be <= current length </div><div class="ttdef"><b>Definition:</b> tdsstring.c:146</div></div>
<div class="ttc" id="a00535_html_ga6aa14b8b717b51afcfb65bd55143689d"><div class="ttname"><a href="a00535.html#ga6aa14b8b717b51afcfb65bd55143689d">tds_dstr_alloc</a></div><div class="ttdeci">DSTR * tds_dstr_alloc(DSTR *s, size_t length)</div><div class="ttdoc">allocate space for length char </div><div class="ttdef"><b>Definition:</b> tdsstring.c:166</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
