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
|
<refentry id="gmime-gmime-filter-windows">
<refmeta>
<refentrytitle>gmime-filter-windows</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gmime-filter-windows</refname><refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<anchor id="GMimeFilterWindows"/>
<synopsis>
<link linkend="GMimeFilterWindows-struct">GMimeFilterWindows</link>;
<link linkend="GMimeFilter">GMimeFilter</link>* <link linkend="g-mime-filter-windows-new">g_mime_filter_windows_new</link> (const <link linkend="char">char</link> *claimed_charset);
<link linkend="gboolean">gboolean</link> <link linkend="g-mime-filter-windows-is-windows-charset">g_mime_filter_windows_is_windows_charset</link>
(<link linkend="GMimeFilterWindows">GMimeFilterWindows</link> *filter);
const <link linkend="char">char</link>* <link linkend="g-mime-filter-windows-real-charset">g_mime_filter_windows_real_charset</link>
(<link linkend="GMimeFilterWindows">GMimeFilterWindows</link> *filter);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GMimeFilter">GMimeFilter</link>
+----GMimeFilterWindows
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimeFilterWindows-struct"/>GMimeFilterWindows</title>
<indexterm><primary>GMimeFilterWindows</primary></indexterm><programlisting>typedef struct _GMimeFilterWindows GMimeFilterWindows;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-windows-new"/>g_mime_filter_windows_new ()</title>
<indexterm><primary>g_mime_filter_windows_new</primary></indexterm><programlisting><link linkend="GMimeFilter">GMimeFilter</link>* g_mime_filter_windows_new (const <link linkend="char">char</link> *claimed_charset);</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>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>claimed_charset</parameter> :</term>
<listitem><simpara> charset that a text stream claims to be
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new windows filter.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-windows-is-windows-charset"/>g_mime_filter_windows_is_windows_charset ()</title>
<indexterm><primary>g_mime_filter_windows_is_windows_charset</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g_mime_filter_windows_is_windows_charset
(<link linkend="GMimeFilterWindows">GMimeFilterWindows</link> *filter);</programlisting>
<para>
Determines whether or not a Windows-CP125# charset has been
detected so far.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filter</parameter> :</term>
<listitem><simpara> windows filter object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><literal>TRUE</literal> if the filtered stream has been detected to contain
Windows-CP125# characters or <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-windows-real-charset"/>g_mime_filter_windows_real_charset ()</title>
<indexterm><primary>g_mime_filter_windows_real_charset</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_filter_windows_real_charset
(<link linkend="GMimeFilterWindows">GMimeFilterWindows</link> *filter);</programlisting>
<para>
Figures out the real charset that the text is encoded in based on whether or not Windows-CP125# characters were found.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filter</parameter> :</term>
<listitem><simpara> windows filter object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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>
</refentry>
|