Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 13eec89779171a321fe518ddb0e0fec6 > files > 188

freetds-doc-0.91-8.mga5.x86_64.rpm

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>FreeTDS API: /home/jklowden/releases/freetds-0.91/include/tdsstring.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>/home/jklowden/releases/freetds-0.91/include/tdsstring.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* FreeTDS - Library of routines accessing Sybase and Microsoft databases</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004  Brian Bruns</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> * Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment"> * License along with this library; if not, write to the</span>
<a name="l00016"></a>00016 <span class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330,</span>
<a name="l00017"></a>00017 <span class="comment"> * Boston, MA 02111-1307, USA.</span>
<a name="l00018"></a>00018 <span class="comment"> */</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _tdsstring_h_</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _tdsstring_h_</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="comment">/* $Id: tdsstring.h,v 1.21 2010/01/25 23:05:59 freddy77 Exp $ */</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#if defined(__GNUC__) &amp;&amp; __GNUC__ &gt;= 4 &amp;&amp; !defined(__MINGW32__)</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#pragma GCC visibility push(hidden)</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> tds_str_empty[1];
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="comment">/* TODO do some function and use inline if available */</span>
<a name="l00032"></a>00032 
<a name="l00037"></a>00037 <span class="preprocessor">#if ENABLE_EXTRA_CHECKS</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="keywordtype">void</span> <a class="code" href="a00303.html#gacd1cdcff8bce3a76e63240798edc9dcb" title="init a string with empty">tds_dstr_init</a>(<a class="code" href="a00100.html">DSTR</a> * s);
<a name="l00039"></a>00039 <span class="keywordtype">int</span> <a class="code" href="a00303.html#gaefed660833fb5beb2b5c7998c565a76c" title="test if string is empty">tds_dstr_isempty</a>(<a class="code" href="a00100.html">DSTR</a> * s);
<a name="l00040"></a>00040 <span class="keywordtype">char</span> *tds_dstr_buf(<a class="code" href="a00100.html">DSTR</a> * s);
<a name="l00041"></a>00041 <span class="keywordtype">size_t</span> tds_dstr_len(<a class="code" href="a00100.html">DSTR</a> * s);
<a name="l00042"></a>00042 <span class="preprocessor">#else</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a><a class="code" href="a00303.html#gacd1cdcff8bce3a76e63240798edc9dcb">00044</a> <span class="preprocessor">#define tds_dstr_init(s) \</span>
<a name="l00045"></a>00045 <span class="preprocessor">        do { DSTR *_tds_s = (s); _tds_s-&gt;dstr_size = 0; _tds_s-&gt;dstr_s = (char*) tds_str_empty; } while(0)</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00048"></a><a class="code" href="a00303.html#gaefed660833fb5beb2b5c7998c565a76c">00048</a> <span class="preprocessor">#define tds_dstr_isempty(s) \</span>
<a name="l00049"></a>00049 <span class="preprocessor">        ((s)-&gt;dstr_size == 0)</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define tds_dstr_buf(s) \</span>
<a name="l00051"></a>00051 <span class="preprocessor">        ((s)-&gt;dstr_s)</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#define tds_dstr_len(s) \</span>
<a name="l00053"></a>00053 <span class="preprocessor">        ((s)-&gt;dstr_size)</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span>
<a name="l00056"></a>00056 <span class="preprocessor">#define tds_dstr_cstr(s) \</span>
<a name="l00057"></a>00057 <span class="preprocessor">        ((const char* ) tds_dstr_buf(s))</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span>
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="a00303.html#ga339ba30216e2bd5bd076aa9dcd26f3c4" title="clear all string filling with zeroes (mainly for security reason)">tds_dstr_zero</a>(<a class="code" href="a00100.html">DSTR</a> * s);
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="a00303.html#gaccd1c1c8ff938813578123963212388c" title="free string">tds_dstr_free</a>(<a class="code" href="a00100.html">DSTR</a> * s);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 <a class="code" href="a00100.html">DSTR</a>* tds_dstr_dup(<a class="code" href="a00100.html">DSTR</a> * s, <span class="keyword">const</span> <a class="code" href="a00100.html">DSTR</a> * src);
<a name="l00063"></a>00063 <a class="code" href="a00100.html">DSTR</a>* <a class="code" href="a00303.html#gad96366d9fa93bfc283cef1299fbe97ab" title="copy a string from another">tds_dstr_copy</a>(<a class="code" href="a00100.html">DSTR</a> * s, <span class="keyword">const</span> <span class="keywordtype">char</span> *src);
<a name="l00064"></a>00064 <a class="code" href="a00100.html">DSTR</a>* <a class="code" href="a00303.html#ga656718f240d7403f986ae887d84a6ca1" title="Set string to a given buffer of characters.">tds_dstr_copyn</a>(<a class="code" href="a00100.html">DSTR</a> * s, <span class="keyword">const</span> <span class="keywordtype">char</span> *src, <span class="keywordtype">size_t</span> length);
<a name="l00065"></a>00065 <a class="code" href="a00100.html">DSTR</a>* <a class="code" href="a00303.html#gab78cc59b110df2817b00f9bed74c6ff1" title="set a string from another buffer.">tds_dstr_set</a>(<a class="code" href="a00100.html">DSTR</a> * s, <span class="keywordtype">char</span> *src);
<a name="l00066"></a>00066 
<a name="l00068"></a>00068 <a class="code" href="a00100.html">DSTR</a>* <a class="code" href="a00303.html#ga0cd7863ba7c2d2da4a193234472a3d14" title="limit length of string, MUST be &amp;lt;= current length">tds_dstr_setlen</a>(<a class="code" href="a00100.html">DSTR</a> *s, <span class="keywordtype">size_t</span> length);
<a name="l00070"></a>00070 <a class="code" href="a00100.html">DSTR</a>* <a class="code" href="a00303.html#ga6aa14b8b717b51afcfb65bd55143689d" title="allocate space for length char">tds_dstr_alloc</a>(<a class="code" href="a00100.html">DSTR</a> *s, <span class="keywordtype">size_t</span> length);
<a name="l00071"></a>00071 
<a name="l00074"></a>00074 <span class="preprocessor">#if defined(__GNUC__) &amp;&amp; __GNUC__ &gt;= 4 &amp;&amp; !defined(__MINGW32__)</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor">#pragma GCC visibility pop</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span>
<a name="l00078"></a>00078 <span class="preprocessor">#endif </span><span class="comment">/* _tdsstring_h_ */</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 17 22:22:30 2011 for FreeTDS API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>