~ubuntu-branches/debian/jessie/glib2.0/jessie

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GUnixOutputStream.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-09-23 10:12:15 UTC
  • mto: This revision was merged to the branch mainline in revision 120.
  • Revision ID: package-import@ubuntu.com-20140923101215-kg4894xy8gz996q1
Tags: upstream-2.42.0
Import upstream version 2.42.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
60
60
</tr>
61
61
<tr>
62
62
<td class="function_type">
63
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
63
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
64
64
</td>
65
65
<td class="function_name">
66
66
<a class="link" href="GUnixOutputStream.html#g-unix-output-stream-get-close-fd" title="g_unix_output_stream_get_close_fd ()">g_unix_output_stream_get_close_fd</a> <span class="c_punctuation">()</span>
68
68
</tr>
69
69
<tr>
70
70
<td class="function_type">
71
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
71
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
72
72
</td>
73
73
<td class="function_name">
74
74
<a class="link" href="GUnixOutputStream.html#g-unix-output-stream-get-fd" title="g_unix_output_stream_get_fd ()">g_unix_output_stream_get_fd</a> <span class="c_punctuation">()</span>
87
87
</colgroup>
88
88
<tbody>
89
89
<tr>
90
 
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
90
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
91
91
<td class="property_name"><a class="link" href="GUnixOutputStream.html#GUnixOutputStream--close-fd" title="The “close-fd” property">close-fd</a></td>
92
92
<td class="property_flags">Read / Write</td>
93
93
</tr>
94
94
<tr>
95
 
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
95
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
96
96
<td class="property_name"><a class="link" href="GUnixOutputStream.html#GUnixOutputStream--fd" title="The “fd” property">fd</a></td>
97
97
<td class="property_flags">Read / Write / Construct Only</td>
98
98
</tr>
114
114
</div>
115
115
<div class="refsect1">
116
116
<a name="GUnixOutputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
117
 
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
117
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
118
118
    <span class="lineart">╰──</span> <a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a>
119
119
        <span class="lineart">╰──</span> GUnixOutputStream
120
120
</pre>
146
146
<div class="refsect2">
147
147
<a name="g-unix-output-stream-new"></a><h3>g_unix_output_stream_new ()</h3>
148
148
<pre class="programlisting"><a class="link" href="GOutputStream.html" title="GOutputStream"><span class="returnvalue">GOutputStream</span></a> *
149
 
g_unix_output_stream_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
150
 
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_fd</code></em>);</pre>
 
149
g_unix_output_stream_new (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
 
150
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_fd</code></em>);</pre>
151
151
<p>Creates a new <a class="link" href="GUnixOutputStream.html" title="GUnixOutputStream"><span class="type">GUnixOutputStream</span></a> for the given <em class="parameter"><code>fd</code></em>
152
152
. </p>
153
153
<p>If <em class="parameter"><code>close_fd</code></em>
154
 
, is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the file descriptor will be closed when 
 
154
, is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the file descriptor will be closed when 
155
155
the output stream is destroyed.</p>
156
156
<div class="refsect3">
157
157
<a name="id-1.4.7.19.10.2.6"></a><h4>Parameters</h4>
169
169
</tr>
170
170
<tr>
171
171
<td class="parameter_name"><p>close_fd</p></td>
172
 
<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the file descriptor when done</p></td>
 
172
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the file descriptor when done</p></td>
173
173
<td class="parameter_annotations"> </td>
174
174
</tr>
175
175
</tbody>
186
186
<a name="g-unix-output-stream-set-close-fd"></a><h3>g_unix_output_stream_set_close_fd ()</h3>
187
187
<pre class="programlisting"><span class="returnvalue">void</span>
188
188
g_unix_output_stream_set_close_fd (<em class="parameter"><code><a class="link" href="GUnixOutputStream.html" title="GUnixOutputStream"><span class="type">GUnixOutputStream</span></a> *stream</code></em>,
189
 
                                   <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_fd</code></em>);</pre>
 
189
                                   <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_fd</code></em>);</pre>
190
190
<p>Sets whether the file descriptor of <em class="parameter"><code>stream</code></em>
191
191
 shall be closed
192
192
when the stream is closed.</p>
206
206
</tr>
207
207
<tr>
208
208
<td class="parameter_name"><p>close_fd</p></td>
209
 
<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the file descriptor when done</p></td>
 
209
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the file descriptor when done</p></td>
210
210
<td class="parameter_annotations"> </td>
211
211
</tr>
212
212
</tbody>
217
217
<hr>
218
218
<div class="refsect2">
219
219
<a name="g-unix-output-stream-get-close-fd"></a><h3>g_unix_output_stream_get_close_fd ()</h3>
220
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
220
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
221
221
g_unix_output_stream_get_close_fd (<em class="parameter"><code><a class="link" href="GUnixOutputStream.html" title="GUnixOutputStream"><span class="type">GUnixOutputStream</span></a> *stream</code></em>);</pre>
222
222
<p>Returns whether the file descriptor of <em class="parameter"><code>stream</code></em>
223
223
 will be
239
239
</div>
240
240
<div class="refsect3">
241
241
<a name="id-1.4.7.19.10.4.6"></a><h4>Returns</h4>
242
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file descriptor is closed when done</p>
 
242
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file descriptor is closed when done</p>
243
243
<p></p>
244
244
</div>
245
245
<p class="since">Since 2.20</p>
247
247
<hr>
248
248
<div class="refsect2">
249
249
<a name="g-unix-output-stream-get-fd"></a><h3>g_unix_output_stream_get_fd ()</h3>
250
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
250
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
251
251
g_unix_output_stream_get_fd (<em class="parameter"><code><a class="link" href="GUnixOutputStream.html" title="GUnixOutputStream"><span class="type">GUnixOutputStream</span></a> *stream</code></em>);</pre>
252
252
<p>Return the UNIX file descriptor that the stream writes to.</p>
253
253
<div class="refsect3">
286
286
<a name="GUnixOutputStream.property-details"></a><h2>Property Details</h2>
287
287
<div class="refsect2">
288
288
<a name="GUnixOutputStream--close-fd"></a><h3>The <code class="literal">“close-fd”</code> property</h3>
289
 
<pre class="programlisting">  “close-fd”                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
 
289
<pre class="programlisting">  “close-fd”                 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
290
290
<p>Whether to close the file descriptor when the stream is closed.</p>
291
291
<p>Flags: Read / Write</p>
292
292
<p>Default value: TRUE</p>
295
295
<hr>
296
296
<div class="refsect2">
297
297
<a name="GUnixOutputStream--fd"></a><h3>The <code class="literal">“fd”</code> property</h3>
298
 
<pre class="programlisting">  “fd”                       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
 
298
<pre class="programlisting">  “fd”                       <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
299
299
<p>The file descriptor that the stream writes to.</p>
300
300
<p>Flags: Read / Write / Construct Only</p>
301
301
<p>Default value: -1</p>