/usr/share/gtk-doc/html/gmime-3.2/gmime-gmime-iconv.html is in libgmime-3.0-doc 3.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gmime-iconv: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="core.html" title="Part III. GMime Core Reference">
<link rel="prev" href="gmime-gmime-charset.html" title="gmime-charset">
<link rel="next" href="gmime-gmime-iconv-utils.html" title="gmime-iconv-utils">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gmime-gmime-iconv.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gmime-gmime-charset.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gmime-gmime-iconv-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gmime-gmime-iconv"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gmime-gmime-iconv.top_of_page"></a>gmime-iconv</span></h2>
<p>gmime-iconv — Low-level routines for converting text from one charset to another</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gmime-gmime-iconv.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">iconv_t</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-open" title="g_mime_iconv_open ()">g_mime_iconv_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()">g_mime_iconv</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-close" title="g_mime_iconv_close ()">g_mime_iconv_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-gmime-iconv.description"></a><h2>Description</h2>
<p>These functions are wrappers around the system iconv(3) routines. The
purpose of this wrapper is to use the appropriate system charset alias for
the MIME charset names given as arguments.</p>
</div>
<div class="refsect1">
<a name="gmime-gmime-iconv.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-iconv-open"></a><h3>g_mime_iconv_open ()</h3>
<pre class="programlisting"><span class="returnvalue">iconv_t</span>
g_mime_iconv_open (<em class="parameter"><code>const <span class="type">char</span> *to</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *from</code></em>);</pre>
<p>Allocates a coversion descriptor suitable for converting byte
sequences from charset <em class="parameter"><code>from</code></em>
to charset <em class="parameter"><code>to</code></em>
. The resulting
descriptor can be used with <code class="function">iconv()</code> (or the <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><code class="function">g_mime_iconv()</code></a> wrapper) any
number of times until closed using <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-close" title="g_mime_iconv_close ()"><code class="function">g_mime_iconv_close()</code></a>.</p>
<p>See the manual page for iconv_open(3) for further details.</p>
<p><span class="annotation">[<a href="http://foldoc.org/skip"><span class="acronym">skip</span></a>]</span></p>
<div class="refsect3">
<a name="g-mime-iconv-open.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>to</p></td>
<td class="parameter_description"><p>charset to convert to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>from</p></td>
<td class="parameter_description"><p>charset to convert from</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-iconv-open.returns"></a><h4>Returns</h4>
<p> a new conversion descriptor for use with <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><code class="function">g_mime_iconv()</code></a> on
success or (iconv_t) <code class="literal">-1</code> on fail as well as setting an appropriate
errno value.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-iconv"></a><h3>g_mime_iconv()</h3>
<pre class="programlisting">#define g_mime_iconv(cd,inbuf,inleft,outbuf,outleft)</pre>
<p>The argument <em class="parameter"><code>cd</code></em>
must be a conversion descriptor created using the
function <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-open" title="g_mime_iconv_open ()"><span class="type">g_mime_iconv_open</span></a>.</p>
<p>The main case is when <em class="parameter"><code>inbuf</code></em>
is not <code class="literal">NULL</code> and *inbuf is not
<code class="literal">NULL</code>. In this case, the <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function converts the
multibyte sequence starting at *inbuf to a multibyte sequence
starting at *outbuf. At most *inleft bytes, starting at *inbuf,
will be read. At most *outleft bytes, starting at *outbuf, will
be written.</p>
<p>The <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function converts one multibyte character at a
time, and for each character conversion it increments *inbuf and
decrements *inleft by the number of converted input bytes, it
increments *outbuf and decrements *outleft by the number of
converted output bytes, and it updates the conversion state
contained in <em class="parameter"><code>cd</code></em>
. The conversion can stop for four reasons:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>An invalid multibyte sequence is encountered in the input. In
this case it sets errno to <code class="literal">EILSEQ</code> and returns (size_t)(-1).
*inbuf is left pointing to the beginning of the invalid multibyte
sequence.</p></li>
<li class="listitem"><p>The input byte sequence has been entirely converted, i.e.
*inleft has gone down to <code class="literal">0</code>. In this case <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> returns
the number of non-reversible conversions performed during this
call.</p></li>
<li class="listitem"><p>An incomplete multibyte sequence is encountered in the input,
and the input byte sequence terminates after it. In this case it
sets errno to <code class="literal">EINVAL</code> and returns (size_t)(-1). *inbuf is left
pointing to the beginning of the incomplete multibyte sequence.</p></li>
<li class="listitem"><p>The output buffer has no more room for the next converted
character. In this case it sets errno to <code class="literal">E2BIG</code> and returns
(size_t)(-1).</p></li>
</ol></div>
<p>A different case is when <em class="parameter"><code>inbuf</code></em>
is <code class="literal">NULL</code> or *inbuf is <code class="literal">NULL</code>, but
<em class="parameter"><code>outbuf</code></em>
is not <code class="literal">NULL</code> and *outbuf is not <code class="literal">NULL</code>. In this case, the
<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function attempts to set <em class="parameter"><code>cd</code></em>
's conversion state to
the initial state and store a corresponding shift sequence at
*outbuf. At most *outleft bytes, starting at *outbuf, will be
written. If the output buffer has no more room for this reset
sequence, it sets errno to <code class="literal">E2BIG</code> and returns (size_t)(-1).
Otherwise it increments *outbuf and decrements *outleft by the
number of bytes written.</p>
<p>A third case is when <em class="parameter"><code>inbuf</code></em>
is <code class="literal">NULL</code> or *inbuf is <code class="literal">NULL</code>, and
<em class="parameter"><code>outbuf</code></em>
is <code class="literal">NULL</code> or *outbuf is <code class="literal">NULL</code>. In this case, the
<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function sets <em class="parameter"><code>cd</code></em>
's conversion state to the initial
state.</p>
<div class="refsect3">
<a name="g-mime-iconv.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cd</p></td>
<td class="parameter_description"><p>iconv_t conversion descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inbuf</p></td>
<td class="parameter_description"><p>input buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inleft</p></td>
<td class="parameter_description"><p>number of bytes left in <em class="parameter"><code>inbuf</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outbuf</p></td>
<td class="parameter_description"><p>output buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outleft</p></td>
<td class="parameter_description"><p>number of bytes left in <em class="parameter"><code>outbuf</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-iconv.returns"></a><h4>Returns</h4>
<p> the number of characters converted in a nonreversible way
during this call; reversible conversions are not counted. In case
of error, it sets errno and returns (size_t)(-1).</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-iconv-close"></a><h3>g_mime_iconv_close ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
g_mime_iconv_close (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>);</pre>
<p>Closes the iconv descriptor <em class="parameter"><code>cd</code></em>
.</p>
<p>See the manual page for iconv_close(3) for further details.</p>
<p><span class="annotation">[<a href="http://foldoc.org/skip"><span class="acronym">skip</span></a>]</span></p>
<div class="refsect3">
<a name="g-mime-iconv-close.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cd</p></td>
<td class="parameter_description"><p>iconv conversion descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-iconv-close.returns"></a><h4>Returns</h4>
<p> <code class="literal">0</code> on success or <code class="literal">-1</code> on fail as well as setting an
appropriate errno value.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gmime-gmime-iconv.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|