Sophie

Sophie

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

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/tdsiconv.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/tdsiconv.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) 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 _tds_iconv_h_</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _tds_iconv_h_</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="comment">/* $Id: tdsiconv.h,v 1.40 2010/07/25 08:40:19 freddy77 Exp $ */</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#if HAVE_ICONV</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include &lt;iconv.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#else</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="comment">/* Define iconv_t for src/replacements/iconv.c. */</span>
<a name="l00029"></a>00029 <span class="preprocessor">#undef iconv_t</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keywordtype">void</span> *iconv_t;
<a name="l00031"></a>00031 <span class="preprocessor">#endif </span><span class="comment">/* HAVE_ICONV */</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#if HAVE_ERRNO_H</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#include &lt;errno.h&gt;</span>
<a name="l00035"></a>00035 <span class="preprocessor">#endif</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="preprocessor">#if HAVE_WCHAR_H</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#include &lt;wchar.h&gt;</span>
<a name="l00039"></a>00039 <span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="comment">/* The following EILSEQ advice is borrowed verbatim from GNU iconv.  */</span>
<a name="l00042"></a>00042 <span class="comment">/* Some systems, like SunOS 4, don&#39;t have EILSEQ. Some systems, like BSD/OS,</span>
<a name="l00043"></a>00043 <span class="comment">   have EILSEQ in a different header.  On these systems, define EILSEQ</span>
<a name="l00044"></a>00044 <span class="comment">   ourselves. */</span>
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef EILSEQ</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor"># define EILSEQ ENOENT</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a>00049 <span class="preprocessor">#if HAVE_STDLIB_H</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#include &lt;stdlib.h&gt;</span>
<a name="l00051"></a>00051 <span class="preprocessor">#endif </span><span class="comment">/* HAVE_STDLIB_H */</span>
<a name="l00052"></a>00052 
<a name="l00053"></a>00053 <span class="preprocessor">#if defined(__GNUC__) &amp;&amp; __GNUC__ &gt;= 4 &amp;&amp; !defined(__MINGW32__)</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#pragma GCC visibility push(hidden)</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span>
<a name="l00057"></a>00057 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <span class="preprocessor">#endif</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span>
<a name="l00062"></a>00062 <span class="preprocessor">#if ! HAVE_ICONV</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span>iconv_t <a class="code" href="a00299.html#ga900b0bce08c6bfc2e7c988f4b5970516" title="Inputs are FreeTDS canonical names, no other.">tds_sys_iconv_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *tocode, <span class="keyword">const</span> <span class="keywordtype">char</span> *fromcode);
<a name="l00064"></a>00064 <span class="keywordtype">size_t</span> tds_sys_iconv(iconv_t cd, <span class="keyword">const</span> <span class="keywordtype">char</span> **inbuf, <span class="keywordtype">size_t</span> * inbytesleft, <span class="keywordtype">char</span> **outbuf, <span class="keywordtype">size_t</span> * outbytesleft);
<a name="l00065"></a>00065 <span class="keywordtype">int</span> tds_sys_iconv_close(iconv_t cd);
<a name="l00066"></a>00066 <span class="preprocessor">#else</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#define tds_sys_iconv_open iconv_open</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#define tds_sys_iconv iconv</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor">#define tds_sys_iconv_close iconv_close</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !HAVE_ICONV */</span>
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00074"></a>00074 { to_server, to_client } TDS_ICONV_DIRECTION;
<a name="l00075"></a>00075 
<a name="l00076"></a><a class="code" href="a00001.html">00076</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00001.html">_character_set_alias</a>
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078         <span class="keyword">const</span> <span class="keywordtype">char</span> *alias;
<a name="l00079"></a>00079         <span class="keywordtype">int</span> canonic;
<a name="l00080"></a>00080 } <a class="code" href="a00001.html">CHARACTER_SET_ALIAS</a>;
<a name="l00081"></a>00081 
<a name="l00082"></a><a class="code" href="a00104.html">00082</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00104.html">tds_errno_message_flags</a> {
<a name="l00083"></a>00083         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> e2big:1;
<a name="l00084"></a>00084         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> eilseq:1;
<a name="l00085"></a>00085         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> einval:1;
<a name="l00086"></a>00086 } <a class="code" href="a00104.html">TDS_ERRNO_MESSAGE_FLAGS</a>;
<a name="l00087"></a>00087 
<a name="l00088"></a><a class="code" href="a00130.html">00088</a> <span class="keyword">struct </span><a class="code" href="a00130.html">tdsiconvinfo</a>
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090         <a class="code" href="a00102.html" title="Information relevant to libiconv.">TDS_ENCODING</a> client_charset;
<a name="l00091"></a>00091         <a class="code" href="a00102.html" title="Information relevant to libiconv.">TDS_ENCODING</a> server_charset;
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="preprocessor">#define TDS_ENCODING_INDIRECT 1</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define TDS_ENCODING_SWAPBYTE 2</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define TDS_ENCODING_MEMCPY   4</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>        <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags;
<a name="l00097"></a>00097 
<a name="l00098"></a>00098         iconv_t to_wire;        <span class="comment">/* conversion from client charset to server&#39;s format */</span>
<a name="l00099"></a>00099         iconv_t from_wire;      <span class="comment">/* conversion from server&#39;s format to client charset */</span>
<a name="l00100"></a>00100 
<a name="l00101"></a>00101         iconv_t to_wire2;       <span class="comment">/* conversion from client charset to server&#39;s format - indirect */</span>
<a name="l00102"></a>00102         iconv_t from_wire2;     <span class="comment">/* conversion from server&#39;s format to client charset - indirect */</span>
<a name="l00103"></a>00103         
<a name="l00104"></a>00104         <span class="comment">/* </span>
<a name="l00105"></a>00105 <span class="comment">         * Suppress error messages that would otherwise be emitted by tds_iconv().</span>
<a name="l00106"></a>00106 <span class="comment">         * Functions that process large buffers ask tds_iconv to convert it in &quot;chunks&quot;.</span>
<a name="l00107"></a>00107 <span class="comment">         * We don&#39;t want to emit spurious EILSEQ errors or multiple errors for one </span>
<a name="l00108"></a>00108 <span class="comment">         * buffer.  tds_iconv() checks this structure before emiting a message, and </span>
<a name="l00109"></a>00109 <span class="comment">         * adds to it whenever it emits one.  Callers that handle a particular situation themselves</span>
<a name="l00110"></a>00110 <span class="comment">         * can prepopulate it.  </span>
<a name="l00111"></a>00111 <span class="comment">         */</span> 
<a name="l00112"></a>00112         <a class="code" href="a00104.html">TDS_ERRNO_MESSAGE_FLAGS</a> suppress;
<a name="l00113"></a>00113 };
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 <span class="comment">/* We use ICONV_CONST for tds_iconv(), even if we don&#39;t have iconv() */</span>
<a name="l00116"></a>00116 <span class="preprocessor">#ifndef ICONV_CONST</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span><span class="preprocessor"># define ICONV_CONST const</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span>
<a name="l00120"></a>00120 <span class="keywordtype">size_t</span> <a class="code" href="a00299.html#gaaa6e5b2df49a1b3e5312f9a4d8f2170f" title="Read a data file, passing the data through iconv().">tds_iconv_fread</a>(iconv_t cd, FILE * stream, <span class="keywordtype">size_t</span> field_len, <span class="keywordtype">size_t</span> term_len, <span class="keywordtype">char</span> *outbuf, <span class="keywordtype">size_t</span> * outbytesleft);
<a name="l00121"></a>00121 <span class="keywordtype">size_t</span> <a class="code" href="a00299.html#ga58d84206127a9777c9bc6daa66cf75d4" title="Wrapper around iconv(3).">tds_iconv</a>(<a class="code" href="a00122.html" title="Information for a server connection.">TDSSOCKET</a> * tds, <span class="keyword">const</span> <a class="code" href="a00130.html">TDSICONV</a> * char_conv, TDS_ICONV_DIRECTION io,
<a name="l00122"></a>00122                  <span class="keyword">const</span> <span class="keywordtype">char</span> **inbuf, <span class="keywordtype">size_t</span> * inbytesleft, <span class="keywordtype">char</span> **outbuf, <span class="keywordtype">size_t</span> * outbytesleft);
<a name="l00123"></a>00123 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="a00299.html#ga6561d1dba1a04c168431b16ec17d7e4c" title="Determine canonical iconv character set name.">tds_canonical_charset_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *charset_name);
<a name="l00124"></a>00124 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="a00299.html#gacf6855134e182dd58507838843ca00c2" title="Determine the name Sybase uses for a character set, given a canonical iconv name...">tds_sybase_charset_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *charset_name);
<a name="l00125"></a>00125 <a class="code" href="a00130.html">TDSICONV</a> *tds_iconv_get(<a class="code" href="a00122.html" title="Information for a server connection.">TDSSOCKET</a> * tds, <span class="keyword">const</span> <span class="keywordtype">char</span> *client_charset, <span class="keyword">const</span> <span class="keywordtype">char</span> *server_charset);
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00128"></a>00128 <span class="preprocessor"></span>}
<a name="l00129"></a>00129 <span class="preprocessor">#endif</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span>
<a name="l00131"></a>00131 <span class="preprocessor">#if defined(__GNUC__) &amp;&amp; __GNUC__ &gt;= 4 &amp;&amp; !defined(__MINGW32__)</span>
<a name="l00132"></a>00132 <span class="preprocessor"></span><span class="preprocessor">#pragma GCC visibility pop</span>
<a name="l00133"></a>00133 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span>
<a name="l00135"></a>00135 <span class="preprocessor">#endif </span><span class="comment">/* _tds_iconv_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>