docs/reference/html/GMimeStreamFs.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>GMimeStreamFs</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="GMimeStreamFile.html" title="GMimeStreamFile">
  10 <link rel="next" href="GMimeStreamMem.html" title="GMimeStreamMem">
  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="GMimeStreamFile.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="GMimeStreamMem.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="#GMimeStreamFs.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeStreamFs.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeStreamFs.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeStreamFs"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeStreamFs.top_of_page"></a>GMimeStreamFs</span></h2>
  36 <p>GMimeStreamFs — A low-level FileSystem stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeStreamFs.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamFs.html#GMimeStreamFs-struct" title="struct GMimeStreamFs">GMimeStreamFs</a>;
  43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-new" title="g_mime_stream_fs_new ()">g_mime_stream_fs_new</a>                (<em class="parameter"><code><span class="type">int</span> fd</code></em>);
  44 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-new-with-bounds" title="g_mime_stream_fs_new_with_bounds ()">g_mime_stream_fs_new_with_bounds</a>    (<em class="parameter"><code><span class="type">int</span> fd</code></em>,
  45                                                          <em class="parameter"><code><span class="type">gint64</span> start</code></em>,
  46                                                          <em class="parameter"><code><span class="type">gint64</span> end</code></em>);
  47 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-get-owner" title="g_mime_stream_fs_get_owner ()">g_mime_stream_fs_get_owner</a>          (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>);
  48 <span class="returnvalue">void</span>                <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-set-owner" title="g_mime_stream_fs_set_owner ()">g_mime_stream_fs_set_owner</a>          (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>,
  49                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="GMimeStreamFs.object-hierarchy"></a><h2>Object Hierarchy</h2>
  54 <pre class="synopsis">
  55   GObject
  56    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
  57          +----GMimeStreamFs
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="GMimeStreamFs.description"></a><h2>Description</h2>
  62 <p>
  63 A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of the
  64 low-level UNIX file descriptor based I/O layer.
  65 </p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="GMimeStreamFs.details"></a><h2>Details</h2>
  69 <div class="refsect2">
  70 <a name="GMimeStreamFs-struct"></a><h3>struct GMimeStreamFs</h3>
  71 <pre class="programlisting">struct GMimeStreamFs;</pre>
  72 <p>
  73 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around POSIX file descriptors.
  74 </p>
  75 <div class="variablelist"><table border="0">
  76 <col align="left" valign="top">
  77 <tbody></tbody>
  78 </table></div>
  79 </div>
  80 <hr>
  81 <div class="refsect2">
  82 <a name="g-mime-stream-fs-new"></a><h3>g_mime_stream_fs_new ()</h3>
  83 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_fs_new                (<em class="parameter"><code><span class="type">int</span> fd</code></em>);</pre>
  84 <p>
  85 Creates a new <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> object around <em class="parameter"><code>fd</code></em>.
  86 </p>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
  92 <td>a file descriptor</td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  96 <td>a stream using <em class="parameter"><code>fd</code></em>.</td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="g-mime-stream-fs-new-with-bounds"></a><h3>g_mime_stream_fs_new_with_bounds ()</h3>
 104 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_fs_new_with_bounds    (<em class="parameter"><code><span class="type">int</span> fd</code></em>,
 105                                                          <em class="parameter"><code><span class="type">gint64</span> start</code></em>,
 106                                                          <em class="parameter"><code><span class="type">gint64</span> end</code></em>);</pre>
 107 <p>
 108 Creates a new <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> object around <em class="parameter"><code>fd</code></em> with bounds <em class="parameter"><code>start</code></em>
 109 and <em class="parameter"><code>end</code></em>.
 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>fd</code></em> :</span></p></td>
 116 <td>a file descriptor</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
 120 <td>start boundary</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
 124 <td>end boundary</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 128 <td>a stream using <em class="parameter"><code>fd</code></em> with bounds <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em>.</td>
 129 </tr>
 130 </tbody>
 131 </table></div>
 132 </div>
 133 <hr>
 134 <div class="refsect2">
 135 <a name="g-mime-stream-fs-get-owner"></a><h3>g_mime_stream_fs_get_owner ()</h3>
 136 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_stream_fs_get_owner          (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>);</pre>
 137 <p>
 138 Gets whether or not <em class="parameter"><code>stream</code></em> owns the backend file descriptor.
 139 </p>
 140 <div class="variablelist"><table border="0">
 141 <col align="left" valign="top">
 142 <tbody>
 143 <tr>
 144 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 145 <td>a <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a>
 146 </td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 150 <td>
 151 <code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em> owns the backend file descriptor or <code class="literal">FALSE</code>
 152 otherwise.</td>
 153 </tr>
 154 </tbody>
 155 </table></div>
 156 </div>
 157 <hr>
 158 <div class="refsect2">
 159 <a name="g-mime-stream-fs-set-owner"></a><h3>g_mime_stream_fs_set_owner ()</h3>
 160 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_stream_fs_set_owner          (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>,
 161                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
 162 <p>
 163 Sets whether or not <em class="parameter"><code>stream</code></em> owns the backend file descriptor.
 164 </p>
 165 <p>
 166 Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should <code class="function">close()</code> the
 167 backend file descriptor when destroyed or <code class="literal">FALSE</code> otherwise.
 168 </p>
 169 <div class="variablelist"><table border="0">
 170 <col align="left" valign="top">
 171 <tbody>
 172 <tr>
 173 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 174 <td>a <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a>
 175 </td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
 179 <td>
 180 <code class="literal">TRUE</code> if this stream should own the file descriptor or <code class="literal">FALSE</code> otherwise</td>
 181 </tr>
 182 </tbody>
 183 </table></div>
 184 </div>
 185 </div>
 186 <div class="refsect1">
 187 <a name="GMimeStreamFs.see-also"></a><h2>See Also</h2>
 188 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 189 </div>
 190 </div>
 191 <div class="footer">
 192 <hr>
 193           Generated by GTK-Doc V1.18</div>
 194 </body>
 195 </html>