docs/reference/html/gmime-gmime-iconv-utils.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gmime-iconv-utils</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="core.html" title="Part III. GMime Core Reference">
   9 <link rel="prev" href="gmime-gmime-iconv.html" title="gmime-iconv">
  10 <link rel="next" href="gmime-gmime-encodings.html" title="gmime-encodings">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gmime-gmime-iconv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="gmime-gmime-encodings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gmime-gmime-iconv-utils.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gmime-gmime-iconv-utils.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gmime-gmime-iconv-utils"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gmime-gmime-iconv-utils.top_of_page"></a>gmime-iconv-utils</span></h2>
  34 <p>gmime-iconv-utils — High-level routines for converting text from one charset to another</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gmime-gmime-iconv-utils.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis"><span class="returnvalue">char</span> *              <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-strdup" title="g_mime_iconv_strdup ()">g_mime_iconv_strdup</a>                 (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>,
  41                                                          <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  42 <span class="returnvalue">char</span> *              <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-strndup" title="g_mime_iconv_strndup ()">g_mime_iconv_strndup</a>                (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>,
  43                                                          <em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
  44                                                          <em class="parameter"><code><span class="type">size_t</span> n</code></em>);
  45 <span class="returnvalue">char</span> *              <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale" title="g_mime_iconv_utf8_to_locale ()">g_mime_iconv_utf8_to_locale</a>         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  46 <span class="returnvalue">char</span> *              <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale-length" title="g_mime_iconv_utf8_to_locale_length ()">g_mime_iconv_utf8_to_locale_length</a>  (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
  47                                                          <em class="parameter"><code><span class="type">size_t</span> n</code></em>);
  48 <span class="returnvalue">char</span> *              <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8" title="g_mime_iconv_locale_to_utf8 ()">g_mime_iconv_locale_to_utf8</a>         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  49 <span class="returnvalue">char</span> *              <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8-length" title="g_mime_iconv_locale_to_utf8_length ()">g_mime_iconv_locale_to_utf8_length</a>  (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
  50                                                          <em class="parameter"><code><span class="type">size_t</span> n</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="gmime-gmime-iconv-utils.description"></a><h2>Description</h2>
  55 <p>
  56 Charset conversion utility functions.
  57 </p>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gmime-gmime-iconv-utils.details"></a><h2>Details</h2>
  61 <div class="refsect2">
  62 <a name="g-mime-iconv-strdup"></a><h3>g_mime_iconv_strdup ()</h3>
  63 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_iconv_strdup                 (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>,
  64                                                          <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
  65 <p>
  66 Allocates a new string buffer containing <em class="parameter"><code>str</code></em> converted to the
  67 destination charset described in <em class="parameter"><code>cd</code></em>.
  68 </p>
  69 <div class="variablelist"><table border="0">
  70 <col align="left" valign="top">
  71 <tbody>
  72 <tr>
  73 <td><p><span class="term"><em class="parameter"><code>cd</code></em> :</span></p></td>
  74 <td>conversion descriptor</td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
  78 <td>string in source charset</td>
  79 </tr>
  80 <tr>
  81 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  82 <td>a new string buffer containing the original string
  83 converted to the new charset.</td>
  84 </tr>
  85 </tbody>
  86 </table></div>
  87 </div>
  88 <hr>
  89 <div class="refsect2">
  90 <a name="g-mime-iconv-strndup"></a><h3>g_mime_iconv_strndup ()</h3>
  91 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_iconv_strndup                (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>,
  92                                                          <em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
  93                                                          <em class="parameter"><code><span class="type">size_t</span> n</code></em>);</pre>
  94 <p>
  95 Allocates a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of <em class="parameter"><code>str</code></em>
  96 converted to the destination charset as described by the conversion
  97 descriptor <em class="parameter"><code>cd</code></em>.
  98 </p>
  99 <div class="variablelist"><table border="0">
 100 <col align="left" valign="top">
 101 <tbody>
 102 <tr>
 103 <td><p><span class="term"><em class="parameter"><code>cd</code></em> :</span></p></td>
 104 <td>conversion descriptor</td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 108 <td>string in source charset</td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 112 <td>number of bytes to convert</td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 116 <td>a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of
 117 <em class="parameter"><code>str</code></em> converted to the destination charset as described by the
 118 conversion descriptor <em class="parameter"><code>cd</code></em>.</td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="g-mime-iconv-utf8-to-locale"></a><h3>g_mime_iconv_utf8_to_locale ()</h3>
 126 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_iconv_utf8_to_locale         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 127 <p>
 128 Allocates a new string buffer containing <em class="parameter"><code>str</code></em> converted to the
 129 user's locale charset.
 130 </p>
 131 <div class="variablelist"><table border="0">
 132 <col align="left" valign="top">
 133 <tbody>
 134 <tr>
 135 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 136 <td>string in UTF-8 charset</td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 140 <td>a new string buffer containing <em class="parameter"><code>str</code></em> converted to the
 141 user's locale charset.</td>
 142 </tr>
 143 </tbody>
 144 </table></div>
 145 </div>
 146 <hr>
 147 <div class="refsect2">
 148 <a name="g-mime-iconv-utf8-to-locale-length"></a><h3>g_mime_iconv_utf8_to_locale_length ()</h3>
 149 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_iconv_utf8_to_locale_length  (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 150                                                          <em class="parameter"><code><span class="type">size_t</span> n</code></em>);</pre>
 151 <p>
 152 Allocates a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of
 153 <em class="parameter"><code>str</code></em> converted to the user's locale charset.
 154 </p>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 160 <td>string in UTF-8 charset</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 164 <td>number of bytes to convert</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 168 <td>a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of
 169 <em class="parameter"><code>str</code></em> converted to the user's locale charset.</td>
 170 </tr>
 171 </tbody>
 172 </table></div>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="g-mime-iconv-locale-to-utf8"></a><h3>g_mime_iconv_locale_to_utf8 ()</h3>
 177 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_iconv_locale_to_utf8         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 178 <p>
 179 Allocates a new string buffer containing <em class="parameter"><code>str</code></em> in UTF-8.
 180 </p>
 181 <div class="variablelist"><table border="0">
 182 <col align="left" valign="top">
 183 <tbody>
 184 <tr>
 185 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 186 <td>string in locale charset</td>
 187 </tr>
 188 <tr>
 189 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 190 <td>a new string buffer containing <em class="parameter"><code>str</code></em> converted to UTF-8.</td>
 191 </tr>
 192 </tbody>
 193 </table></div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="g-mime-iconv-locale-to-utf8-length"></a><h3>g_mime_iconv_locale_to_utf8_length ()</h3>
 198 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_iconv_locale_to_utf8_length  (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 199                                                          <em class="parameter"><code><span class="type">size_t</span> n</code></em>);</pre>
 200 <p>
 201 Allocates a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of
 202 <em class="parameter"><code>str</code></em> converted to UTF-8.
 203 </p>
 204 <div class="variablelist"><table border="0">
 205 <col align="left" valign="top">
 206 <tbody>
 207 <tr>
 208 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 209 <td>string in locale charset</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 213 <td>number of bytes to convert</td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 217 <td>a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of
 218 <em class="parameter"><code>str</code></em> converted to UTF-8.</td>
 219 </tr>
 220 </tbody>
 221 </table></div>
 222 </div>
 223 </div>
 224 </div>
 225 <div class="footer">
 226 <hr>
 227           Generated by GTK-Doc V1.18</div>
 228 </body>
 229 </html>