docs/reference/html/GMimeFilterWindows.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>GMimeFilterWindows</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="Filters.html" title="Stream Filters">
   9 <link rel="prev" href="GMimeFilterStrip.html" title="GMimeFilterStrip">
  10 <link rel="next" href="GMimeFilterYenc.html" title="GMimeFilterYenc">
  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="GMimeFilterStrip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Filters.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="GMimeFilterYenc.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="#GMimeFilterWindows.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeFilterWindows.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeFilterWindows.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeFilterWindows"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeFilterWindows.top_of_page"></a>GMimeFilterWindows</span></h2>
  36 <p>GMimeFilterWindows — Determine if text is in a Microsoft Windows codepage</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeFilterWindows.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeFilterWindows.html#GMimeFilterWindows-struct" title="struct GMimeFilterWindows">GMimeFilterWindows</a>;
  43 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       <a class="link" href="GMimeFilterWindows.html#g-mime-filter-windows-new" title="g_mime_filter_windows_new ()">g_mime_filter_windows_new</a>           (<em class="parameter"><code>const <span class="type">char</span> *claimed_charset</code></em>);
  44 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeFilterWindows.html#g-mime-filter-windows-is-windows-charset" title="g_mime_filter_windows_is_windows_charset ()">g_mime_filter_windows_is_windows_charset</a>
  45                                                         (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>);
  46 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeFilterWindows.html#g-mime-filter-windows-real-charset" title="g_mime_filter_windows_real_charset ()">g_mime_filter_windows_real_charset</a>  (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="GMimeFilterWindows.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   GObject
  53    +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
  54          +----GMimeFilterWindows
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="GMimeFilterWindows.description"></a><h2>Description</h2>
  59 <p>
  60 A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for determining if text marked as iso-8859-##
  61 is actually encoded in one of the Windows-CP125# charsets.
  62 </p>
  63 </div>
  64 <div class="refsect1">
  65 <a name="GMimeFilterWindows.details"></a><h2>Details</h2>
  66 <div class="refsect2">
  67 <a name="GMimeFilterWindows-struct"></a><h3>struct GMimeFilterWindows</h3>
  68 <pre class="programlisting">struct GMimeFilterWindows;</pre>
  69 <p>
  70 A filter for detecting whether or not a text stream claimed to be
  71 iso-8859-X is really that charset or if it is really a
  72 Windows-CP125x charset.
  73 </p>
  74 <div class="variablelist"><table border="0">
  75 <col align="left" valign="top">
  76 <tbody></tbody>
  77 </table></div>
  78 </div>
  79 <hr>
  80 <div class="refsect2">
  81 <a name="g-mime-filter-windows-new"></a><h3>g_mime_filter_windows_new ()</h3>
  82 <pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       g_mime_filter_windows_new           (<em class="parameter"><code>const <span class="type">char</span> *claimed_charset</code></em>);</pre>
  83 <p>
  84 Creates a new GMimeFilterWindows filter. When a stream of text has
  85 been filtered, it can be determined whether or not said text stream
  86 was in <em class="parameter"><code>claimed_charset</code></em> or the equivalent Windows-CP125# charset.
  87 </p>
  88 <div class="variablelist"><table border="0">
  89 <col align="left" valign="top">
  90 <tbody>
  91 <tr>
  92 <td><p><span class="term"><em class="parameter"><code>claimed_charset</code></em> :</span></p></td>
  93 <td>charset that a text stream claims to be</td>
  94 </tr>
  95 <tr>
  96 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  97 <td>a new windows filter.</td>
  98 </tr>
  99 </tbody>
 100 </table></div>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="g-mime-filter-windows-is-windows-charset"></a><h3>g_mime_filter_windows_is_windows_charset ()</h3>
 105 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_filter_windows_is_windows_charset
 106                                                         (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>);</pre>
 107 <p>
 108 Determines whether or not a Windows-CP125# charset has been
 109 detected so far.
 110 </p>
 111 <div class="variablelist"><table border="0">
 112 <col align="left" valign="top">
 113 <tbody>
 114 <tr>
 115 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 116 <td>windows filter object</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 120 <td>
 121 <code class="literal">TRUE</code> if the filtered stream has been detected to contain
 122 Windows-CP125# characters or <code class="literal">FALSE</code> otherwise.</td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="g-mime-filter-windows-real-charset"></a><h3>g_mime_filter_windows_real_charset ()</h3>
 130 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_filter_windows_real_charset  (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>);</pre>
 131 <p>
 132 Figures out the real charset that the text is encoded in based on whether or not Windows-CP125# characters were found.
 133 </p>
 134 <div class="variablelist"><table border="0">
 135 <col align="left" valign="top">
 136 <tbody>
 137 <tr>
 138 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 139 <td>windows filter object</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 143 <td>a const string pointer to the claimed charset if filtered
 144 text stream was found not to contain any Windows-CP125# characters
 145 or the proper Windows-CP125# charset.</td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 </div>
 150 </div>
 151 <div class="refsect1">
 152 <a name="GMimeFilterWindows.see-also"></a><h2>See Also</h2>
 153 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a>
 154 </div>
 155 </div>
 156 <div class="footer">
 157 <hr>
 158           Generated by GTK-Doc V1.18</div>
 159 </body>
 160 </html>