~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2014-03-24 20:58:34 UTC
  • mfrom: (1.66.13)
  • Revision ID: package-import@ubuntu.com-20140324205834-8hsgok8k36ftocqa
Tags: 2.40.0-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
58
58
</tr>
59
59
<tr>
60
60
<td class="function_type">
61
 
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
62
62
</td>
63
63
<td class="function_name">
64
64
<a class="link" href="GUnixFDList.html#g-unix-fd-list-get-length" title="g_unix_fd_list_get_length ()">g_unix_fd_list_get_length</a> <span class="c_punctuation">()</span>
66
66
</tr>
67
67
<tr>
68
68
<td class="function_type">
69
 
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
70
70
</td>
71
71
<td class="function_name">
72
72
<a class="link" href="GUnixFDList.html#g-unix-fd-list-get" title="g_unix_fd_list_get ()">g_unix_fd_list_get</a> <span class="c_punctuation">()</span>
73
73
</td>
74
74
</tr>
75
75
<tr>
76
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
 
76
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
77
77
</td>
78
78
<td class="function_name">
79
79
<a class="link" href="GUnixFDList.html#g-unix-fd-list-peek-fds" title="g_unix_fd_list_peek_fds ()">g_unix_fd_list_peek_fds</a> <span class="c_punctuation">()</span>
81
81
</tr>
82
82
<tr>
83
83
<td class="function_type">
84
 
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
 
84
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
85
85
</td>
86
86
<td class="function_name">
87
87
<a class="link" href="GUnixFDList.html#g-unix-fd-list-steal-fds" title="g_unix_fd_list_steal_fds ()">g_unix_fd_list_steal_fds</a> <span class="c_punctuation">()</span>
89
89
</tr>
90
90
<tr>
91
91
<td class="function_type">
92
 
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
92
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
93
93
</td>
94
94
<td class="function_name">
95
95
<a class="link" href="GUnixFDList.html#g-unix-fd-list-append" title="g_unix_fd_list_append ()">g_unix_fd_list_append</a> <span class="c_punctuation">()</span>
113
113
</div>
114
114
<div class="refsect1">
115
115
<a name="GUnixFDList.object-hierarchy"></a><h2>Object Hierarchy</h2>
116
 
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
116
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
117
117
    <span class="lineart">╰──</span> GUnixFDList
118
118
</pre>
119
119
</div>
138
138
<div class="refsect2">
139
139
<a name="g-unix-fd-list-new-from-array"></a><h3>g_unix_fd_list_new_from_array ()</h3>
140
140
<pre class="programlisting"><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="returnvalue">GUnixFDList</span></a> *
141
 
g_unix_fd_list_new_from_array (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *fds</code></em>,
142
 
                               <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_fds</code></em>);</pre>
 
141
g_unix_fd_list_new_from_array (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *fds</code></em>,
 
142
                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_fds</code></em>);</pre>
143
143
<p>Creates a new <a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> containing the file descriptors given in
144
144
<em class="parameter"><code>fds</code></em>
145
145
.  The file descriptors become the property of the new list and
194
194
<hr>
195
195
<div class="refsect2">
196
196
<a name="g-unix-fd-list-get-length"></a><h3>g_unix_fd_list_get_length ()</h3>
197
 
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
197
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
198
198
g_unix_fd_list_get_length (<em class="parameter"><code><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> *list</code></em>);</pre>
199
199
<p>Gets the length of <em class="parameter"><code>list</code></em>
200
200
 (ie: the number of file descriptors
225
225
<hr>
226
226
<div class="refsect2">
227
227
<a name="g-unix-fd-list-get"></a><h3>g_unix_fd_list_get ()</h3>
228
 
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
228
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
229
229
g_unix_fd_list_get (<em class="parameter"><code><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> *list</code></em>,
230
 
                    <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index_</code></em>,
231
 
                    <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
230
                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index_</code></em>,
 
231
                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
232
232
<p>Gets a file descriptor out of <em class="parameter"><code>list</code></em>
233
233
.</p>
234
234
<p><em class="parameter"><code>index_</code></em>
262
262
</tr>
263
263
<tr>
264
264
<td class="parameter_name"><p>error</p></td>
265
 
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointer</p></td>
 
265
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointer</p></td>
266
266
<td class="parameter_annotations"> </td>
267
267
</tr>
268
268
</tbody>
278
278
<hr>
279
279
<div class="refsect2">
280
280
<a name="g-unix-fd-list-peek-fds"></a><h3>g_unix_fd_list_peek_fds ()</h3>
281
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
 
281
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
282
282
g_unix_fd_list_peek_fds (<em class="parameter"><code><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> *list</code></em>,
283
 
                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *length</code></em>);</pre>
 
283
                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *length</code></em>);</pre>
284
284
<p>Returns the array of file descriptors that is contained in this
285
285
object.</p>
286
286
<p>After this call, the descriptors remain the property of <em class="parameter"><code>list</code></em>
289
289
valid only until <em class="parameter"><code>list</code></em>
290
290
 is changed in any way.</p>
291
291
<p>If <em class="parameter"><code>length</code></em>
292
 
 is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it is set to the number of file
 
292
 is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it is set to the number of file
293
293
descriptors in the returned array. The returned array is also
294
294
terminated with -1.</p>
295
 
<p>This function never returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. In case there are no file
 
295
<p>This function never returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. In case there are no file
296
296
descriptors contained in <em class="parameter"><code>list</code></em>
297
297
, an empty array is returned.</p>
298
298
<div class="refsect3">
312
312
<tr>
313
313
<td class="parameter_name"><p>length</p></td>
314
314
<td class="parameter_description"><p> pointer to the length of the returned
315
 
array, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
315
array, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
316
316
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
317
317
</tr>
318
318
</tbody>
329
329
<hr>
330
330
<div class="refsect2">
331
331
<a name="g-unix-fd-list-steal-fds"></a><h3>g_unix_fd_list_steal_fds ()</h3>
332
 
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
 
332
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> *
333
333
g_unix_fd_list_steal_fds (<em class="parameter"><code><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> *list</code></em>,
334
 
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *length</code></em>);</pre>
 
334
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *length</code></em>);</pre>
335
335
<p>Returns the array of file descriptors that is contained in this
336
336
object.</p>
337
337
<p>After this call, the descriptors are no longer contained in
338
338
<em class="parameter"><code>list</code></em>
339
339
. Further calls will return an empty list (unless more
340
340
descriptors have been added).</p>
341
 
<p>The return result of this function must be freed with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
 
341
<p>The return result of this function must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
342
342
The caller is also responsible for closing all of the file
343
343
descriptors.  The file descriptors in the array are set to
344
344
close-on-exec.</p>
345
345
<p>If <em class="parameter"><code>length</code></em>
346
 
 is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it is set to the number of file
 
346
 is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it is set to the number of file
347
347
descriptors in the returned array. The returned array is also
348
348
terminated with -1.</p>
349
 
<p>This function never returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. In case there are no file
 
349
<p>This function never returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. In case there are no file
350
350
descriptors contained in <em class="parameter"><code>list</code></em>
351
351
, an empty array is returned.</p>
352
352
<div class="refsect3">
366
366
<tr>
367
367
<td class="parameter_name"><p>length</p></td>
368
368
<td class="parameter_description"><p> pointer to the length of the returned
369
 
array, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
369
array, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
370
370
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
371
371
</tr>
372
372
</tbody>
383
383
<hr>
384
384
<div class="refsect2">
385
385
<a name="g-unix-fd-list-append"></a><h3>g_unix_fd_list_append ()</h3>
386
 
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 
386
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
387
387
g_unix_fd_list_append (<em class="parameter"><code><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> *list</code></em>,
388
 
                       <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
389
 
                       <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
388
                       <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>,
 
389
                       <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
390
390
<p>Adds a file descriptor to <em class="parameter"><code>list</code></em>
391
391
.</p>
392
392
<p>The file descriptor is duplicated using <code class="function">dup()</code>. You keep your copy
420
420
</tr>
421
421
<tr>
422
422
<td class="parameter_name"><p>error</p></td>
423
 
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointer</p></td>
 
423
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointer</p></td>
424
424
<td class="parameter_annotations"> </td>
425
425
</tr>
426
426
</tbody>