docs/reference/html/GMimeFilterCRLF.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>GMimeFilterCRLF</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="GMimeFilterCharset.html" title="GMimeFilterCharset">
  10 <link rel="next" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched">
  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="GMimeFilterCharset.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="GMimeFilterEnriched.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="#GMimeFilterCRLF.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeFilterCRLF.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeFilterCRLF.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeFilterCRLF"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeFilterCRLF.top_of_page"></a>GMimeFilterCRLF</span></h2>
  36 <p>GMimeFilterCRLF — Convert line-endings from LF to CRLF or vise versa</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeFilterCRLF.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeFilterCRLF.html#GMimeFilterCRLF-struct" title="struct GMimeFilterCRLF">GMimeFilterCRLF</a>;
  43 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       <a class="link" href="GMimeFilterCRLF.html#g-mime-filter-crlf-new" title="g_mime_filter_crlf_new ()">g_mime_filter_crlf_new</a>              (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>,
  44                                                          <em class="parameter"><code><span class="type">gboolean</span> dots</code></em>);
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="GMimeFilterCRLF.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   GObject
  51    +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
  52          +----GMimeFilterCRLF
  53 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="GMimeFilterCRLF.description"></a><h2>Description</h2>
  57 <p>
  58 A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> for converting between DOS and UNIX line-endings.
  59 </p>
  60 </div>
  61 <div class="refsect1">
  62 <a name="GMimeFilterCRLF.details"></a><h2>Details</h2>
  63 <div class="refsect2">
  64 <a name="GMimeFilterCRLF-struct"></a><h3>struct GMimeFilterCRLF</h3>
  65 <pre class="programlisting">struct GMimeFilterCRLF;</pre>
  66 <p>
  67 A filter to convert between line-ending formats and encode/decode
  68 lines beginning with a '.'.
  69 </p>
  70 <div class="variablelist"><table border="0">
  71 <col align="left" valign="top">
  72 <tbody></tbody>
  73 </table></div>
  74 </div>
  75 <hr>
  76 <div class="refsect2">
  77 <a name="g-mime-filter-crlf-new"></a><h3>g_mime_filter_crlf_new ()</h3>
  78 <pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       g_mime_filter_crlf_new              (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>,
  79                                                          <em class="parameter"><code><span class="type">gboolean</span> dots</code></em>);</pre>
  80 <p>
  81 Creates a new <a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF"><span class="type">GMimeFilterCRLF</span></a> filter.
  82 </p>
  83 <p>
  84 If <em class="parameter"><code>encode</code></em> is <code class="literal">TRUE</code>, then lone line-feeds ('\n') will be 'encoded'
  85 into the canonical CRLF end-of-line sequence ("\r\n") otherwise
  86 CRLF sequences will be 'decoded' into the UNIX line-ending form
  87 ('\n').
  88 </p>
  89 <p>
  90 The <em class="parameter"><code>dots</code></em> parameter tells the filter whether or not it should
  91 encode or decode lines beginning with a dot ('.'). If both <em class="parameter"><code>encode</code></em>
  92 and <em class="parameter"><code>dots</code></em> are <code class="literal">TRUE</code>, then a '.' at the beginning of a line will be
  93 'encoded' into "..". If <em class="parameter"><code>encode</code></em> is <code class="literal">FALSE</code>, then ".." at the
  94 beginning of a line will be decoded into a single '.'.
  95 </p>
  96 <div class="variablelist"><table border="0">
  97 <col align="left" valign="top">
  98 <tbody>
  99 <tr>
 100 <td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td>
 101 <td>
 102 <code class="literal">TRUE</code> if the filter should encode or <code class="literal">FALSE</code> otherwise</td>
 103 </tr>
 104 <tr>
 105 <td><p><span class="term"><em class="parameter"><code>dots</code></em> :</span></p></td>
 106 <td>encode/decode dots (as for SMTP)</td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 110 <td>a new <a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF"><span class="type">GMimeFilterCRLF</span></a> filter.</td>
 111 </tr>
 112 </tbody>
 113 </table></div>
 114 </div>
 115 </div>
 116 </div>
 117 <div class="footer">
 118 <hr>
 119           Generated by GTK-Doc V1.18</div>
 120 </body>
 121 </html>