docs/reference/html/GMimeStreamCat.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>GMimeStreamCat</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="Streams.html" title="Streams">
   9 <link rel="prev" href="GMimeStreamPipe.html" title="GMimeStreamPipe">
  10 <link rel="next" href="Filters.html" title="Stream Filters">
  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="GMimeStreamPipe.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Streams.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="Filters.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="#GMimeStreamCat.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeStreamCat.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeStreamCat.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeStreamCat"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeStreamCat.top_of_page"></a>GMimeStreamCat</span></h2>
  36 <p>GMimeStreamCat — A concatenated stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeStreamCat.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamCat.html#GMimeStreamCat-struct" title="struct GMimeStreamCat">GMimeStreamCat</a>;
  43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamCat.html#g-mime-stream-cat-new" title="g_mime_stream_cat_new ()">g_mime_stream_cat_new</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 <span class="returnvalue">int</span>                 <a class="link" href="GMimeStreamCat.html#g-mime-stream-cat-add-source" title="g_mime_stream_cat_add_source ()">g_mime_stream_cat_add_source</a>        (<em class="parameter"><code><a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> *cat</code></em>,
  45                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *source</code></em>);
  46 </pre>
  47 </div>
  48 <div class="refsect1">
  49 <a name="GMimeStreamCat.object-hierarchy"></a><h2>Object Hierarchy</h2>
  50 <pre class="synopsis">
  51   GObject
  52    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
  53          +----GMimeStreamCat
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="GMimeStreamCat.description"></a><h2>Description</h2>
  58 <p>
  59 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which chains together any number of other streams.
  60 </p>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GMimeStreamCat.details"></a><h2>Details</h2>
  64 <div class="refsect2">
  65 <a name="GMimeStreamCat-struct"></a><h3>struct GMimeStreamCat</h3>
  66 <pre class="programlisting">struct GMimeStreamCat;</pre>
  67 <p>
  68 A concatenation of other <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> objects.
  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-stream-cat-new"></a><h3>g_mime_stream_cat_new ()</h3>
  78 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_cat_new               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  79 <p>
  80 Creates a new <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> object.
  81 </p>
  82 <div class="variablelist"><table border="0">
  83 <col align="left" valign="top">
  84 <tbody><tr>
  85 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  86 <td>a new <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> stream.</td>
  87 </tr></tbody>
  88 </table></div>
  89 </div>
  90 <hr>
  91 <div class="refsect2">
  92 <a name="g-mime-stream-cat-add-source"></a><h3>g_mime_stream_cat_add_source ()</h3>
  93 <pre class="programlisting"><span class="returnvalue">int</span>                 g_mime_stream_cat_add_source        (<em class="parameter"><code><a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> *cat</code></em>,
  94                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *source</code></em>);</pre>
  95 <p>
  96 Adds the <em class="parameter"><code>source</code></em> stream to the <em class="parameter"><code>cat</code></em>.
  97 </p>
  98 <div class="variablelist"><table border="0">
  99 <col align="left" valign="top">
 100 <tbody>
 101 <tr>
 102 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
 103 <td>a <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a>
 104 </td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 108 <td>a source stream</td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 112 <td>
 113 <code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 </div>
 118 </div>
 119 <div class="refsect1">
 120 <a name="GMimeStreamCat.see-also"></a><h2>See Also</h2>
 121 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 122 </div>
 123 </div>
 124 <div class="footer">
 125 <hr>
 126           Generated by GTK-Doc V1.18</div>
 127 </body>
 128 </html>