<refentry id="GMimeFilterWindows">
<refmeta>
<refentrytitle role="top_of_page" id="GMimeFilterWindows.top_of_page">GMimeFilterWindows</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GMIME Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GMimeFilterWindows</refname>
<refpurpose>Determine if text is in a Microsoft Windows codepage</refpurpose>
</refnamediv>

<refsynopsisdiv id="GMimeFilterWindows.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>                    <link linkend="GMimeFilterWindows-struct">GMimeFilterWindows</link>;
<link linkend="GMimeFilter"><returnvalue>GMimeFilter</returnvalue></link> *       <link linkend="g-mime-filter-windows-new">g_mime_filter_windows_new</link>           (<parameter>const <link linkend="char"><type>char</type></link> *claimed_charset</parameter>);
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="g-mime-filter-windows-is-windows-charset">g_mime_filter_windows_is_windows_charset</link>
                                                        (<parameter><link linkend="GMimeFilterWindows"><type>GMimeFilterWindows</type></link> *filter</parameter>);
const <link linkend="char"><returnvalue>char</returnvalue></link> *        <link linkend="g-mime-filter-windows-real-charset">g_mime_filter_windows_real_charset</link>  (<parameter><link linkend="GMimeFilterWindows"><type>GMimeFilterWindows</type></link> *filter</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GMimeFilterWindows.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GMimeFilter">GMimeFilter</link>
         +----GMimeFilterWindows
</synopsis>
</refsect1>

<refsect1 id="GMimeFilterWindows.description" role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="GMimeFilter"><type>GMimeFilter</type></link> used for determining if text marked as iso-8859-##
is actually encoded in one of the Windows-CP125# charsets.
</para>
</refsect1>
<refsect1 id="GMimeFilterWindows.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GMimeFilterWindows-struct" role="struct">
<title>GMimeFilterWindows</title>
<indexterm zone="GMimeFilterWindows-struct"><primary>GMimeFilterWindows</primary></indexterm>
<programlisting>typedef struct _GMimeFilterWindows GMimeFilterWindows;</programlisting>
<para>
A filter for detecting whether or not a text stream claimed to be
iso-8859-X is really that charset or if it is really a
Windows-CP125x charset.
</para><variablelist role="struct">
</variablelist></refsect2>
<refsect2 id="g-mime-filter-windows-new" role="function">
<title>g_mime_filter_windows_new ()</title>
<indexterm zone="g-mime-filter-windows-new"><primary>g_mime_filter_windows_new</primary></indexterm>
<programlisting><link linkend="GMimeFilter"><returnvalue>GMimeFilter</returnvalue></link> *       g_mime_filter_windows_new           (<parameter>const <link linkend="char"><type>char</type></link> *claimed_charset</parameter>);</programlisting>
<para>
Creates a new GMimeFilterWindows filter. When a stream of text has
been filtered, it can be determined whether or not said text stream
was in <parameter>claimed_charset</parameter> or the equivalent Windows-CP125# charset.
</para><variablelist role="params">
<varlistentry><term><parameter>claimed_charset</parameter>&#160;:</term>
<listitem><simpara>charset that a text stream claims to be
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new windows filter.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g-mime-filter-windows-is-windows-charset" role="function">
<title>g_mime_filter_windows_is_windows_charset ()</title>
<indexterm zone="g-mime-filter-windows-is-windows-charset"><primary>g_mime_filter_windows_is_windows_charset</primary></indexterm>
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            g_mime_filter_windows_is_windows_charset
                                                        (<parameter><link linkend="GMimeFilterWindows"><type>GMimeFilterWindows</type></link> *filter</parameter>);</programlisting>
<para>
Determines whether or not a Windows-CP125# charset has been
detected so far.
</para><variablelist role="params">
<varlistentry><term><parameter>filter</parameter>&#160;:</term>
<listitem><simpara>windows filter object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the filtered stream has been detected to contain
Windows-CP125# characters or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g-mime-filter-windows-real-charset" role="function">
<title>g_mime_filter_windows_real_charset ()</title>
<indexterm zone="g-mime-filter-windows-real-charset"><primary>g_mime_filter_windows_real_charset</primary></indexterm>
<programlisting>const <link linkend="char"><returnvalue>char</returnvalue></link> *        g_mime_filter_windows_real_charset  (<parameter><link linkend="GMimeFilterWindows"><type>GMimeFilterWindows</type></link> *filter</parameter>);</programlisting>
<para>
Figures out the real charset that the text is encoded in based on whether or not Windows-CP125# characters were found.
</para><variablelist role="params">
<varlistentry><term><parameter>filter</parameter>&#160;:</term>
<listitem><simpara>windows filter object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a const string pointer to the claimed charset if filtered
text stream was found not to contain any Windows-CP125# characters
or the proper Windows-CP125# charset.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GMimeFilterWindows.see-also">
<title>See Also</title>
<link linkend="GMimeFilter"><type>GMimeFilter</type></link>
</refsect1>

</refentry>
