<!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/iconv.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">iconv.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) 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 _tds_iconv_h_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _tds_iconv_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">#if HAVE_ICONV</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <iconv.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* Define iconv_t for src/replacements/iconv.c. */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#undef iconv_t</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *iconv_t;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif </span><span class="comment">/* HAVE_ICONV */</span><span class="preprocessor"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#if HAVE_ERRNO_H</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <errno.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#if HAVE_WCHAR_H</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <wchar.h></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/* The following EILSEQ advice is borrowed verbatim from GNU iconv. */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/* Some systems, like SunOS 4, don't have EILSEQ. Some systems, like BSD/OS,</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> have EILSEQ in a different header. On these systems, define EILSEQ</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> ourselves. */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifndef EILSEQ</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"># define EILSEQ ENOENT</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#if HAVE_STDLIB_H</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include <stdlib.h></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif </span><span class="comment">/* HAVE_STDLIB_H */</span><span class="preprocessor"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#include <freetds/pushvis.h></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#if ! HAVE_ICONV</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> iconv_t <a class="code" href="a00531.html#ga900b0bce08c6bfc2e7c988f4b5970516">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);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <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);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">int</span> tds_sys_iconv_close(iconv_t cd);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#define tds_sys_iconv_open iconv_open</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#define tds_sys_iconv iconv</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define tds_sys_iconv_close iconv_close</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif </span><span class="comment">/* !HAVE_ICONV */</span><span class="preprocessor"></span></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> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> { to_server, to_client } TDS_ICONV_DIRECTION;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="a00933.html"> 72</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00933.html">_character_set_alias</a></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *alias;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> canonic;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> } <a class="code" href="a00933.html">CHARACTER_SET_ALIAS</a>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="a00937.html"> 78</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00937.html">tds_errno_message_flags</a> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> e2big:1;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> eilseq:1;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> einval:1;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> } <a class="code" href="a00937.html">TDS_ERRNO_MESSAGE_FLAGS</a>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="a00941.html"> 84</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00941.html">tdsiconvdir</a></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="a01121.html">TDS_ENCODING</a> charset;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  iconv_t cd;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> } <a class="code" href="a00941.html">TDSICONVDIR</a>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="a00945.html"> 91</a></span> <span class="keyword">struct </span><a class="code" href="a00945.html">tdsiconvinfo</a></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">struct </span><a class="code" href="a00941.html">tdsiconvdir</a> to, from;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define TDS_ENCODING_MEMCPY 1</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">/* </span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * Suppress error messages that would otherwise be emitted by tds_iconv().</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * Functions that process large buffers ask tds_iconv to convert it in "chunks".</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * We don't want to emit spurious EILSEQ errors or multiple errors for one </span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * buffer. tds_iconv() checks this structure before emiting a message, and </span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * adds to it whenever it emits one. Callers that handle a particular situation themselves</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * can prepopulate it. </span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="a00937.html">TDS_ERRNO_MESSAGE_FLAGS</a> suppress;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> };</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">/* We use ICONV_CONST for tds_iconv(), even if we don't have iconv() */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#ifndef ICONV_CONST</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"># define ICONV_CONST const</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">size_t</span> <a class="code" href="a00531.html#ga87db49044919f1bc84c0ff5e9ab00304">tds_iconv</a>(<a class="code" href="a01193.html">TDSSOCKET</a> * tds, <a class="code" href="a00945.html">TDSICONV</a> * char_conv, TDS_ICONV_DIRECTION io,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <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);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="a00531.html#ga6561d1dba1a04c168431b16ec17d7e4c">tds_canonical_charset_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *charset_name);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <a class="code" href="a00945.html">TDSICONV</a> *tds_iconv_get(<a class="code" href="a01189.html">TDSCONNECTION</a> * conn, <span class="keyword">const</span> <span class="keywordtype">char</span> *client_charset, <span class="keyword">const</span> <span class="keywordtype">char</span> *server_charset);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#include <freetds/popvis.h></span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif </span><span class="comment">/* _tds_iconv_h_ */</span><span class="preprocessor"></span></div><div class="ttc" id="a00531_html_ga900b0bce08c6bfc2e7c988f4b5970516"><div class="ttname"><a href="a00531.html#ga900b0bce08c6bfc2e7c988f4b5970516">tds_sys_iconv_open</a></div><div class="ttdeci">iconv_t tds_sys_iconv_open(const char *tocode, const char *fromcode)</div><div class="ttdoc">Inputs are FreeTDS canonical names, no other. </div><div class="ttdef"><b>Definition:</b> iconv.c:337</div></div>
<div class="ttc" id="a01193_html"><div class="ttname"><a href="a01193.html">tds_socket</a></div><div class="ttdoc">Information for a server connection. </div><div class="ttdef"><b>Definition:</b> tds.h:1174</div></div>
<div class="ttc" id="a00941_html"><div class="ttname"><a href="a00941.html">tdsiconvdir</a></div><div class="ttdef"><b>Definition:</b> iconv.h:84</div></div>
<div class="ttc" id="a01121_html"><div class="ttname"><a href="a01121.html">tds_encoding</a></div><div class="ttdoc">Information relevant to libiconv. </div><div class="ttdef"><b>Definition:</b> tds.h:648</div></div>
<div class="ttc" id="a00937_html"><div class="ttname"><a href="a00937.html">tds_errno_message_flags</a></div><div class="ttdef"><b>Definition:</b> iconv.h:78</div></div>
<div class="ttc" id="a00945_html"><div class="ttname"><a href="a00945.html">tdsiconvinfo</a></div><div class="ttdef"><b>Definition:</b> iconv.h:91</div></div>
<div class="ttc" id="a00933_html"><div class="ttname"><a href="a00933.html">_character_set_alias</a></div><div class="ttdef"><b>Definition:</b> iconv.h:72</div></div>
<div class="ttc" id="a00531_html_ga6561d1dba1a04c168431b16ec17d7e4c"><div class="ttname"><a href="a00531.html#ga6561d1dba1a04c168431b16ec17d7e4c">tds_canonical_charset_name</a></div><div class="ttdeci">const char * tds_canonical_charset_name(const char *charset_name)</div><div class="ttdoc">Determine canonical iconv character set name. </div><div class="ttdef"><b>Definition:</b> iconv.c:949</div></div>
<div class="ttc" id="a01189_html"><div class="ttname"><a href="a01189.html">tds_connection</a></div><div class="ttdef"><b>Definition:</b> tds.h:1102</div></div>
<div class="ttc" id="a00531_html_ga87db49044919f1bc84c0ff5e9ab00304"><div class="ttname"><a href="a00531.html#ga87db49044919f1bc84c0ff5e9ab00304">tds_iconv</a></div><div class="ttdeci">size_t tds_iconv(TDSSOCKET *tds, TDSICONV *char_conv, TDS_ICONV_DIRECTION io, const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft)</div><div class="ttdoc">Wrapper around iconv(3). </div><div class="ttdef"><b>Definition:</b> iconv.c:546</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>
