docs/reference/html/gmime-gmime-charset.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-charset</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.html" title="gmime">
  10 <link rel="next" href="gmime-gmime-iconv.html" title="gmime-iconv">
  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.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-iconv.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-charset.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gmime-gmime-charset.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gmime-gmime-charset"></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-charset.top_of_page"></a>gmime-charset</span></h2>
  34 <p>gmime-charset — Charset helper functions</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gmime-gmime-charset.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">                    <a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset">GMimeCharset</a>;
  41 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()">g_mime_charset_map_init</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
  42 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-shutdown" title="g_mime_charset_map_shutdown ()">g_mime_charset_map_shutdown</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
  43 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-locale-charset" title="g_mime_locale_charset ()">g_mime_locale_charset</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-locale-language" title="g_mime_locale_language ()">g_mime_locale_language</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
  45 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-language" title="g_mime_charset_language ()">g_mime_charset_language</a>             (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);
  46 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-canon-name" title="g_mime_charset_canon_name ()">g_mime_charset_canon_name</a>           (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);
  47 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-iconv-name" title="g_mime_charset_iconv_name ()">g_mime_charset_iconv_name</a>           (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);
  48 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-name" title="g_mime_charset_name ()">g_mime_charset_name</a>                 (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);
  49 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-locale-name" title="g_mime_charset_locale_name ()">g_mime_charset_locale_name</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
  50 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-iso-to-windows" title="g_mime_charset_iso_to_windows ()">g_mime_charset_iso_to_windows</a>       (<em class="parameter"><code>const <span class="type">char</span> *isocharset</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime-charset.html#g-mime-charset-init" title="g_mime_charset_init ()">g_mime_charset_init</a>                 (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);
  52 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime-charset.html#g-mime-charset-step" title="g_mime_charset_step ()">g_mime_charset_step</a>                 (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>,
  53                                                          <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>,
  54                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>);
  55 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best-name" title="g_mime_charset_best_name ()">g_mime_charset_best_name</a>            (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);
  56 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best" title="g_mime_charset_best ()">g_mime_charset_best</a>                 (<em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>,
  57                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>);
  58 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-gmime-charset.html#g-mime-charset-can-encode" title="g_mime_charset_can_encode ()">g_mime_charset_can_encode</a>           (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *mask</code></em>,
  59                                                          <em class="parameter"><code>const <span class="type">char</span> *charset</code></em>,
  60                                                          <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
  61                                                          <em class="parameter"><code><span class="type">size_t</span> len</code></em>);
  62 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime-charset.html#g-mime-set-user-charsets" title="g_mime_set_user_charsets ()">g_mime_set_user_charsets</a>            (<em class="parameter"><code>const <span class="type">char</span> **charsets</code></em>);
  63 const <span class="returnvalue">char</span> **       <a class="link" href="gmime-gmime-charset.html#g-mime-user-charsets" title="g_mime_user_charsets ()">g_mime_user_charsets</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gmime-gmime-charset.description"></a><h2>Description</h2>
  68 <p>
  69 Charset utility functions.
  70 </p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="gmime-gmime-charset.details"></a><h2>Details</h2>
  74 <div class="refsect2">
  75 <a name="GMimeCharset"></a><h3>GMimeCharset</h3>
  76 <pre class="programlisting">typedef struct {
  77         unsigned int mask;
  78         unsigned int level;
  79 } GMimeCharset;
  80 </pre>
  81 <p>
  82 State used by <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best" title="g_mime_charset_best ()"><code class="function">g_mime_charset_best()</code></a> and <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best-name" title="g_mime_charset_best_name ()"><code class="function">g_mime_charset_best_name()</code></a>.
  83 </p>
  84 <div class="variablelist"><table border="0">
  85 <col align="left" valign="top">
  86 <tbody>
  87 <tr>
  88 <td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="GMimeCharset.mask"></a>mask</code></em>;</span></p></td>
  89 <td>charset mask</td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="GMimeCharset.level"></a>level</code></em>;</span></p></td>
  93 <td>charset level</td>
  94 </tr>
  95 </tbody>
  96 </table></div>
  97 </div>
  98 <hr>
  99 <div class="refsect2">
 100 <a name="g-mime-charset-map-init"></a><h3>g_mime_charset_map_init ()</h3>
 101 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_charset_map_init             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 102 <p>
 103 Initializes character set maps.
 104 </p>
 105 <p>
 106 Note: <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a> calls this routine for you.
 107 </p>
 108 </div>
 109 <hr>
 110 <div class="refsect2">
 111 <a name="g-mime-charset-map-shutdown"></a><h3>g_mime_charset_map_shutdown ()</h3>
 112 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_charset_map_shutdown         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 113 <p>
 114 Frees internal lookup tables created in <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()"><code class="function">g_mime_charset_map_init()</code></a>.
 115 </p>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="g-mime-locale-charset"></a><h3>g_mime_locale_charset ()</h3>
 120 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_locale_charset               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 121 <p>
 122 Gets the user's locale charset (or iso-8859-1 by default).
 123 </p>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody><tr>
 127 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 128 <td>the user's locale charset (or iso-8859-1 by default).</td>
 129 </tr></tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="g-mime-locale-language"></a><h3>g_mime_locale_language ()</h3>
 135 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_locale_language              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 136 <p>
 137 Gets the user's locale language code (or <code class="literal">NULL</code> by default).
 138 </p>
 139 <div class="variablelist"><table border="0">
 140 <col align="left" valign="top">
 141 <tbody><tr>
 142 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 143 <td>the user's locale language code (or <code class="literal">NULL</code> by default).</td>
 144 </tr></tbody>
 145 </table></div>
 146 </div>
 147 <hr>
 148 <div class="refsect2">
 149 <a name="g-mime-charset-language"></a><h3>g_mime_charset_language ()</h3>
 150 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_language             (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre>
 151 <p>
 152 Attempts to find a specific language code that is specific to
 153 <em class="parameter"><code>charset</code></em>. Currently only handles CJK and Russian/Ukranian
 154 charset-&gt;lang mapping. Everything else will return <code class="literal">NULL</code>.
 155 </p>
 156 <div class="variablelist"><table border="0">
 157 <col align="left" valign="top">
 158 <tbody>
 159 <tr>
 160 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 161 <td>charset name</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 165 <td>a language code that is specific to <em class="parameter"><code>charset</code></em>, or <code class="literal">NULL</code> on
 166 fail.</td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 <hr>
 172 <div class="refsect2">
 173 <a name="g-mime-charset-canon-name"></a><h3>g_mime_charset_canon_name ()</h3>
 174 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_canon_name           (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre>
 175 <p>
 176 Attempts to find a canonical charset name for <em class="parameter"><code>charset</code></em>.
 177 </p>
 178 <p>
 179 Note: Will normally return the same value as
 180 <a class="link" href="gmime-gmime-charset.html#g-mime-charset-iconv-name" title="g_mime_charset_iconv_name ()"><code class="function">g_mime_charset_iconv_name()</code></a> unless the system iconv does not use
 181 the canonical ISO charset names (such as using ISO8859-1 rather
 182 than the canonical form ISO-8859-1).
 183 </p>
 184 <div class="variablelist"><table border="0">
 185 <col align="left" valign="top">
 186 <tbody>
 187 <tr>
 188 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 189 <td>charset name</td>
 190 </tr>
 191 <tr>
 192 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 193 <td>a canonical charset name for <em class="parameter"><code>charset</code></em>.</td>
 194 </tr>
 195 </tbody>
 196 </table></div>
 197 </div>
 198 <hr>
 199 <div class="refsect2">
 200 <a name="g-mime-charset-iconv-name"></a><h3>g_mime_charset_iconv_name ()</h3>
 201 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_iconv_name           (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre>
 202 <p>
 203 Attempts to find an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>.
 204 </p>
 205 <div class="variablelist"><table border="0">
 206 <col align="left" valign="top">
 207 <tbody>
 208 <tr>
 209 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 210 <td>charset name</td>
 211 </tr>
 212 <tr>
 213 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 214 <td>an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>.</td>
 215 </tr>
 216 </tbody>
 217 </table></div>
 218 </div>
 219 <hr>
 220 <div class="refsect2">
 221 <a name="g-mime-charset-name"></a><h3>g_mime_charset_name ()</h3>
 222 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_name                 (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre>
 223 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 224 <h3 class="title">Warning</h3>
 225 <p><code class="literal">g_mime_charset_name</code> is deprecated and should not be used in newly-written code.</p>
 226 </div>
 227 <p>
 228 Attempts to find an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>.
 229 </p>
 230 <p>
 231 Note: This function is deprecated. Use <a class="link" href="gmime-gmime-charset.html#g-mime-charset-iconv-name" title="g_mime_charset_iconv_name ()"><code class="function">g_mime_charset_iconv_name()</code></a>
 232 instead.
 233 </p>
 234 <div class="variablelist"><table border="0">
 235 <col align="left" valign="top">
 236 <tbody>
 237 <tr>
 238 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 239 <td>charset name</td>
 240 </tr>
 241 <tr>
 242 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 243 <td>an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>.</td>
 244 </tr>
 245 </tbody>
 246 </table></div>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="g-mime-charset-locale-name"></a><h3>g_mime_charset_locale_name ()</h3>
 251 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_locale_name          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 252 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 253 <h3 class="title">Warning</h3>
 254 <p><code class="literal">g_mime_charset_locale_name</code> is deprecated and should not be used in newly-written code.</p>
 255 </div>
 256 <p>
 257 Gets the user's locale charset (or iso-8859-1 by default).
 258 </p>
 259 <p>
 260 Note: This function is deprecated. Use <a class="link" href="gmime-gmime-charset.html#g-mime-locale-charset" title="g_mime_locale_charset ()"><code class="function">g_mime_locale_charset()</code></a>
 261 instead.
 262 </p>
 263 <div class="variablelist"><table border="0">
 264 <col align="left" valign="top">
 265 <tbody><tr>
 266 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 267 <td>the user's locale charset (or iso-8859-1 by default).</td>
 268 </tr></tbody>
 269 </table></div>
 270 </div>
 271 <hr>
 272 <div class="refsect2">
 273 <a name="g-mime-charset-iso-to-windows"></a><h3>g_mime_charset_iso_to_windows ()</h3>
 274 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_iso_to_windows       (<em class="parameter"><code>const <span class="type">char</span> *isocharset</code></em>);</pre>
 275 <p>
 276 Maps the ISO-8859-# charset to the equivalent Windows-CP125#
 277 charset.
 278 </p>
 279 <div class="variablelist"><table border="0">
 280 <col align="left" valign="top">
 281 <tbody>
 282 <tr>
 283 <td><p><span class="term"><em class="parameter"><code>isocharset</code></em> :</span></p></td>
 284 <td>ISO-8859-# charset</td>
 285 </tr>
 286 <tr>
 287 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 288 <td>equivalent Windows charset.</td>
 289 </tr>
 290 </tbody>
 291 </table></div>
 292 </div>
 293 <hr>
 294 <div class="refsect2">
 295 <a name="g-mime-charset-init"></a><h3>g_mime_charset_init ()</h3>
 296 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_charset_init                 (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);</pre>
 297 <p>
 298 Initializes a charset mask structure.
 299 </p>
 300 <div class="variablelist"><table border="0">
 301 <col align="left" valign="top">
 302 <tbody><tr>
 303 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 304 <td>charset mask</td>
 305 </tr></tbody>
 306 </table></div>
 307 </div>
 308 <hr>
 309 <div class="refsect2">
 310 <a name="g-mime-charset-step"></a><h3>g_mime_charset_step ()</h3>
 311 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_charset_step                 (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>,
 312                                                          <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>,
 313                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>);</pre>
 314 <p>
 315 Steps through the input buffer 1 unicode character (glyph) at a
 316 time (ie, not necessarily 1 byte at a time). Bitwise 'and' our
 317 <em class="parameter"><code>charset-&gt;mask</code></em> with the mask for each glyph. This has the effect of
 318 limiting what charsets our <em class="parameter"><code>charset-&gt;mask</code></em> can match.
 319 </p>
 320 <div class="variablelist"><table border="0">
 321 <col align="left" valign="top">
 322 <tbody>
 323 <tr>
 324 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 325 <td>charset structure</td>
 326 </tr>
 327 <tr>
 328 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 329 <td>input text buffer (must be in UTF-8)</td>
 330 </tr>
 331 <tr>
 332 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 333 <td>input buffer length</td>
 334 </tr>
 335 </tbody>
 336 </table></div>
 337 </div>
 338 <hr>
 339 <div class="refsect2">
 340 <a name="g-mime-charset-best-name"></a><h3>g_mime_charset_best_name ()</h3>
 341 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_best_name            (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);</pre>
 342 <p>
 343 Gets the best charset name based on the charset mask <em class="parameter"><code>charset</code></em>.
 344 </p>
 345 <div class="variablelist"><table border="0">
 346 <col align="left" valign="top">
 347 <tbody>
 348 <tr>
 349 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 350 <td>charset mask</td>
 351 </tr>
 352 <tr>
 353 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 354 <td>a pointer to a string containing the best charset name that
 355 can represent the charset mask <em class="parameter"><code>charset</code></em>.</td>
 356 </tr>
 357 </tbody>
 358 </table></div>
 359 </div>
 360 <hr>
 361 <div class="refsect2">
 362 <a name="g-mime-charset-best"></a><h3>g_mime_charset_best ()</h3>
 363 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_charset_best                 (<em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>,
 364                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>);</pre>
 365 <p>
 366 Computes the best charset to use to encode this text buffer.
 367 </p>
 368 <div class="variablelist"><table border="0">
 369 <col align="left" valign="top">
 370 <tbody>
 371 <tr>
 372 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 373 <td>a UTF-8 text buffer</td>
 374 </tr>
 375 <tr>
 376 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 377 <td>input buffer length</td>
 378 </tr>
 379 <tr>
 380 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 381 <td>the charset name best suited for the input text or <code class="literal">NULL</code> if
 382 it is US-ASCII safe.</td>
 383 </tr>
 384 </tbody>
 385 </table></div>
 386 </div>
 387 <hr>
 388 <div class="refsect2">
 389 <a name="g-mime-charset-can-encode"></a><h3>g_mime_charset_can_encode ()</h3>
 390 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_charset_can_encode           (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *mask</code></em>,
 391                                                          <em class="parameter"><code>const <span class="type">char</span> *charset</code></em>,
 392                                                          <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
 393                                                          <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre>
 394 <p>
 395 Check to see if the UTF-8 <em class="parameter"><code>text</code></em> will fit safely within <em class="parameter"><code>charset</code></em>.
 396 </p>
 397 <div class="variablelist"><table border="0">
 398 <col align="left" valign="top">
 399 <tbody>
 400 <tr>
 401 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 402 <td>a <a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> mask</td>
 403 </tr>
 404 <tr>
 405 <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
 406 <td>a charset</td>
 407 </tr>
 408 <tr>
 409 <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 410 <td>utf-8 text to check</td>
 411 </tr>
 412 <tr>
 413 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
 414 <td>length of <em class="parameter"><code>text</code></em>
 415 </td>
 416 </tr>
 417 <tr>
 418 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 419 <td>
 420 <code class="literal">TRUE</code> if it is safe to encode <em class="parameter"><code>text</code></em> into <em class="parameter"><code>charset</code></em> or <code class="literal">FALSE</code>
 421 otherwise.</td>
 422 </tr>
 423 </tbody>
 424 </table></div>
 425 </div>
 426 <hr>
 427 <div class="refsect2">
 428 <a name="g-mime-set-user-charsets"></a><h3>g_mime_set_user_charsets ()</h3>
 429 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_set_user_charsets            (<em class="parameter"><code>const <span class="type">char</span> **charsets</code></em>);</pre>
 430 <p>
 431 Set a list of charsets for GMime to use as a hint for encoding and
 432 decoding headers. The charset list should be in order of preference
 433 (e.g. most preferred first, least preferred last).
 434 </p>
 435 <div class="variablelist"><table border="0">
 436 <col align="left" valign="top">
 437 <tbody><tr>
 438 <td><p><span class="term"><em class="parameter"><code>charsets</code></em> :</span></p></td>
 439 <td>an array of user-preferred charsets</td>
 440 </tr></tbody>
 441 </table></div>
 442 </div>
 443 <hr>
 444 <div class="refsect2">
 445 <a name="g-mime-user-charsets"></a><h3>g_mime_user_charsets ()</h3>
 446 <pre class="programlisting">const <span class="returnvalue">char</span> **       g_mime_user_charsets                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 447 <p>
 448 Get the list of user-preferred charsets set with
 449 <a class="link" href="gmime-gmime-charset.html#g-mime-set-user-charsets" title="g_mime_set_user_charsets ()"><code class="function">g_mime_set_user_charsets()</code></a>.
 450 </p>
 451 <div class="variablelist"><table border="0">
 452 <col align="left" valign="top">
 453 <tbody><tr>
 454 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 455 <td>an array of user-set charsets or <code class="literal">NULL</code> if none set.</td>
 456 </tr></tbody>
 457 </table></div>
 458 </div>
 459 </div>
 460 </div>
 461 <div class="footer">
 462 <hr>
 463           Generated by GTK-Doc V1.18</div>
 464 </body>
 465 </html>