← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/html/GInputStream.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GInputStream</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIO Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="GIO Reference Manual">
8
8
<link rel="up" href="streaming.html" title="Streaming I/O">
9
9
<link rel="prev" href="GSeekable.html" title="GSeekable">
10
10
<link rel="next" href="GOutputStream.html" title="GOutputStream">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;GIO Overview">
 
13
<link rel="part" href="pt01.html" title="Part I. GIO Overview">
14
14
<link rel="chapter" href="ch01.html" title="Introduction">
15
15
<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
16
16
<link rel="chapter" href="ch03.html" title="Running GIO applications">
17
 
<link rel="chapter" href="gio-extension-points.html" title="Extending GIO">
18
 
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
 
17
<link rel="chapter" href="extending-gio.html" title="Extending GIO">
 
18
<link rel="part" href="pt02.html" title="Part II. API Reference">
19
19
<link rel="chapter" href="file_ops.html" title="File Operations">
20
20
<link rel="chapter" href="file_mon.html" title="File System Monitoring">
21
21
<link rel="chapter" href="async.html" title="Asynchronous I/O">
25
25
<link rel="chapter" href="icons.html" title="Icons">
26
26
<link rel="chapter" href="utils.html" title="Utilities">
27
27
<link rel="chapter" href="extending.html" title="Extending GIO">
28
 
<link rel="part" href="migrating.html" title="Part&#160;III.&#160;Migrating to GIO">
 
28
<link rel="part" href="migrating.html" title="Part III. Migrating to GIO">
29
29
<link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO">
30
30
<link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO">
31
31
<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
32
32
<link rel="index" href="ix01.html" title="Index">
 
33
<link rel="index" href="ix02.html" title="Index of new symbols in 2.18">
33
34
</head>
34
35
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
35
36
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
40
41
<th width="100%" align="center">GIO Reference Manual</th>
41
42
<td><a accesskey="n" href="GOutputStream.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
42
43
</tr>
43
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2779002" class="shortcut">Top</a>
44
 
                  &#160;|&#160;
45
 
                  <a href="#id2843054" class="shortcut">Description</a>
46
 
                  &#160;|&#160;
47
 
                  <a href="#id2843005" class="shortcut">Object Hierarchy</a></nobr></td></tr>
 
44
<tr><td colspan="5" class="shortcuts">
 
45
<a href="#GInputStream.synopsis" class="shortcut">Top</a>
 
46
                 | 
 
47
                <a href="#GInputStream.description" class="shortcut">Description</a>
 
48
                 | 
 
49
                <a href="#GInputStream.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
50
</td></tr>
48
51
</table>
49
52
<div class="refentry" lang="en">
50
53
<a name="GInputStream"></a><div class="titlepage"></div>
51
54
<div class="refnamediv"><table width="100%"><tr>
52
55
<td valign="top">
53
 
<h2>
54
 
<a name="id2779002"></a><span class="refentrytitle">GInputStream</span>
55
 
</h2>
56
 
<p>GInputStream &#8212; Base class for implementing streaming input</p>
 
56
<h2><span class="refentrytitle"><a name="GInputStream.top_of_page"></a>GInputStream</span></h2>
 
57
<p>GInputStream — Base class for implementing streaming input</p>
57
58
</td>
58
59
<td valign="top" align="right"></td>
59
60
</tr></table></div>
60
61
<div class="refsynopsisdiv">
61
 
<h2>Synopsis</h2>
 
62
<a name="GInputStream.synopsis"></a><h2>Synopsis</h2>
62
63
<pre class="synopsis">
63
64
 
64
65
#include &lt;gio/gio.h&gt;
65
66
 
66
 
 
67
 
                    <a class="link" href="GInputStream.html#GInputStream-struct">GInputStream</a>;
 
67
                    <a class="link" href="GInputStream.html#GInputStream-struct" title="GInputStream">GInputStream</a>;
68
68
<a
69
69
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
70
 
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-read">g_input_stream_read</a>                 (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
70
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-read" title="g_input_stream_read ()">g_input_stream_read</a>                 (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
71
71
                                                         void *buffer,
72
72
                                                         <a
73
73
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
78
78
>GError</a> **error);
79
79
<a
80
80
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
81
 
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-read-all">g_input_stream_read_all</a>             (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
81
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-read-all" title="g_input_stream_read_all ()">g_input_stream_read_all</a>             (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
82
82
                                                         void *buffer,
83
83
                                                         <a
84
84
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
92
92
>GError</a> **error);
93
93
<a
94
94
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
95
 
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-skip">g_input_stream_skip</a>                 (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
95
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-skip" title="g_input_stream_skip ()">g_input_stream_skip</a>                 (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
96
96
                                                         <a
97
97
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
98
98
>gsize</a> count,
102
102
>GError</a> **error);
103
103
<a
104
104
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
105
 
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-close">g_input_stream_close</a>                (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
105
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-close" title="g_input_stream_close ()">g_input_stream_close</a>                (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
106
106
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
107
107
                                                         <a
108
108
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
109
109
>GError</a> **error);
110
 
void                <a class="link" href="GInputStream.html#g-input-stream-read-async">g_input_stream_read_async</a>           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
110
void                <a class="link" href="GInputStream.html#g-input-stream-read-async" title="g_input_stream_read_async ()">g_input_stream_read_async</a>           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
111
111
                                                         void *buffer,
112
112
                                                         <a
113
113
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
114
114
>gsize</a> count,
115
115
                                                         int io_priority,
116
116
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
117
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
117
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
118
118
                                                         <a
119
119
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
120
120
>gpointer</a> user_data);
121
121
<a
122
122
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
123
 
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-read-finish">g_input_stream_read_finish</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
123
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-read-finish" title="g_input_stream_read_finish ()">g_input_stream_read_finish</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
124
124
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
125
125
                                                         <a
126
126
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
127
127
>GError</a> **error);
128
 
void                <a class="link" href="GInputStream.html#g-input-stream-skip-async">g_input_stream_skip_async</a>           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
128
void                <a class="link" href="GInputStream.html#g-input-stream-skip-async" title="g_input_stream_skip_async ()">g_input_stream_skip_async</a>           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
129
129
                                                         <a
130
130
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
131
131
>gsize</a> count,
132
132
                                                         int io_priority,
133
133
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
134
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
134
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
135
135
                                                         <a
136
136
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
137
137
>gpointer</a> user_data);
138
138
<a
139
139
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
140
 
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-skip-finish">g_input_stream_skip_finish</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
140
>gssize</a>              <a class="link" href="GInputStream.html#g-input-stream-skip-finish" title="g_input_stream_skip_finish ()">g_input_stream_skip_finish</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
141
141
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
142
142
                                                         <a
143
143
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
144
144
>GError</a> **error);
145
 
void                <a class="link" href="GInputStream.html#g-input-stream-close-async">g_input_stream_close_async</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
145
void                <a class="link" href="GInputStream.html#g-input-stream-close-async" title="g_input_stream_close_async ()">g_input_stream_close_async</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
146
146
                                                         int io_priority,
147
147
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
148
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
148
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
149
149
                                                         <a
150
150
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
151
151
>gpointer</a> user_data);
152
152
<a
153
153
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
154
 
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-close-finish">g_input_stream_close_finish</a>         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
154
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-close-finish" title="g_input_stream_close_finish ()">g_input_stream_close_finish</a>         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
155
155
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
156
156
                                                         <a
157
157
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
158
158
>GError</a> **error);
159
159
<a
160
160
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
161
 
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-is-closed">g_input_stream_is_closed</a>            (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);
162
 
<a
163
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
164
 
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-has-pending">g_input_stream_has_pending</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);
165
 
<a
166
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
167
 
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-set-pending">g_input_stream_set_pending</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
161
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-is-closed" title="g_input_stream_is_closed ()">g_input_stream_is_closed</a>            (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);
 
162
<a
 
163
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
164
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-has-pending" title="g_input_stream_has_pending ()">g_input_stream_has_pending</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);
 
165
<a
 
166
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
167
>gboolean</a>            <a class="link" href="GInputStream.html#g-input-stream-set-pending" title="g_input_stream_set_pending ()">g_input_stream_set_pending</a>          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
168
168
                                                         <a
169
169
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
170
170
>GError</a> **error);
171
 
void                <a class="link" href="GInputStream.html#g-input-stream-clear-pending">g_input_stream_clear_pending</a>        (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);
172
 
 
173
 
 
 
171
void                <a class="link" href="GInputStream.html#g-input-stream-clear-pending" title="g_input_stream_clear_pending ()">g_input_stream_clear_pending</a>        (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);
174
172
</pre>
175
173
</div>
176
174
<div class="refsect1" lang="en">
177
 
<a name="id2843005"></a><h2>Object Hierarchy</h2>
 
175
<a name="GInputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
178
176
<pre class="synopsis">
179
 
 
180
177
  <a
181
178
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
182
179
>GObject</a>
183
180
   +----GInputStream
184
 
         +----<a class="link" href="GUnixInputStream.html" title="GUnixInputStream">GUnixInputStream</a>
185
 
         +----<a class="link" href="GMemoryInputStream.html" title="GMemoryInputStream">GMemoryInputStream</a>
186
181
         +----<a class="link" href="GFilterInputStream.html" title="GFilterInputStream">GFilterInputStream</a>
187
182
         +----<a class="link" href="GFileInputStream.html" title="GFileInputStream">GFileInputStream</a>
 
183
         +----<a class="link" href="GMemoryInputStream.html" title="GMemoryInputStream">GMemoryInputStream</a>
 
184
         +----<a class="link" href="GUnixInputStream.html" title="GUnixInputStream">GUnixInputStream</a>
188
185
</pre>
189
186
</div>
190
187
<div class="refsect1" lang="en">
191
 
<a name="id2843054"></a><h2>Description</h2>
192
 
<p>
193
 
</p>
194
 
<p>
195
 
 
 
188
<a name="GInputStream.description"></a><h2>Description</h2>
 
189
<p>
 
190
GInputStream has functions to read from a stream (<a class="link" href="GInputStream.html#g-input-stream-read" title="g_input_stream_read ()"><code class="function">g_input_stream_read()</code></a>),
 
191
to close a stream (<a class="link" href="GInputStream.html#g-input-stream-close" title="g_input_stream_close ()"><code class="function">g_input_stream_close()</code></a>) and to skip some content
 
192
(<a class="link" href="GInputStream.html#g-input-stream-skip" title="g_input_stream_skip ()"><code class="function">g_input_stream_skip()</code></a>). 
 
193
</p>
 
194
<p>
 
195
To copy the content of an input stream to an output stream without 
 
196
manually handling the reads and writes, use <a class="link" href="GOutputStream.html#g-output-stream-splice" title="g_output_stream_splice ()"><code class="function">g_output_stream_splice()</code></a>. 
 
197
</p>
 
198
<p>
 
199
All of these functions have async variants too.</p>
 
200
<p>
196
201
</p>
197
202
</div>
198
203
<div class="refsect1" lang="en">
199
 
<a name="id2843074"></a><h2>Details</h2>
 
204
<a name="GInputStream.details"></a><h2>Details</h2>
200
205
<div class="refsect2" lang="en">
201
 
<a name="id2843084"></a><h3>
202
 
<a name="GInputStream-struct"></a>GInputStream</h3>
203
 
<a class="indexterm" name="id2843097"></a><pre class="programlisting">typedef struct _GInputStream GInputStream;</pre>
 
206
<a name="GInputStream-struct"></a><h3>GInputStream</h3>
 
207
<pre class="programlisting">typedef struct _GInputStream GInputStream;</pre>
204
208
<p>
205
209
Base class for streaming input operations.</p>
206
210
<p>
207
 
 
208
211
</p>
209
212
</div>
210
213
<hr>
211
214
<div class="refsect2" lang="en">
212
 
<a name="id2843116"></a><h3>
213
 
<a name="g-input-stream-read"></a>g_input_stream_read ()</h3>
214
 
<a class="indexterm" name="id2849193"></a><pre class="programlisting"><a
 
215
<a name="g-input-stream-read"></a><h3>g_input_stream_read ()</h3>
 
216
<pre class="programlisting"><a
215
217
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
216
218
>gssize</a>              g_input_stream_read                 (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
217
219
                                                         void *buffer,
229
231
<p>
230
232
If count is zero returns zero and does nothing. A value of <em class="parameter"><code>count</code></em>
231
233
larger than <a
232
 
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE:CAPS"
233
 
><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.
 
234
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE--CAPS"
 
235
><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT--CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.
234
236
</p>
235
237
<p>
236
238
On success, the number of bytes read into the buffer is returned.
248
250
<p>
249
251
On error -1 is returned and <em class="parameter"><code>error</code></em> is set accordingly.</p>
250
252
<p>
251
 
 
252
253
</p>
253
254
<div class="variablelist"><table border="0">
254
255
<col align="left" valign="top">
255
256
<tbody>
256
257
<tr>
257
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
258
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
258
259
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
259
260
</td>
260
261
</tr>
261
262
<tr>
262
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></p></td>
 
263
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
263
264
<td> a buffer to read data into (which should be at least count bytes long).
264
265
</td>
265
266
</tr>
266
267
<tr>
267
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
268
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
268
269
<td> the number of bytes that will be read from the stream
269
270
</td>
270
271
</tr>
271
272
<tr>
272
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
273
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
273
274
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
274
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
275
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
275
276
><code class="literal">NULL</code></a> to ignore.
276
277
</td>
277
278
</tr>
278
279
<tr>
279
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
280
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
280
281
<td> location to store the error occuring, or <a
281
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
282
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
282
283
><code class="literal">NULL</code></a> to ignore
283
284
</td>
284
285
</tr>
285
286
<tr>
286
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
287
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
287
288
<td> Number of bytes read, or -1 on error
288
289
</td>
289
290
</tr>
292
293
</div>
293
294
<hr>
294
295
<div class="refsect2" lang="en">
295
 
<a name="id2849452"></a><h3>
296
 
<a name="g-input-stream-read-all"></a>g_input_stream_read_all ()</h3>
297
 
<a class="indexterm" name="id2849463"></a><pre class="programlisting"><a
 
296
<a name="g-input-stream-read-all"></a><h3>g_input_stream_read_all ()</h3>
 
297
<pre class="programlisting"><a
298
298
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
299
299
>gboolean</a>            g_input_stream_read_all             (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
300
300
                                                         void *buffer,
313
313
<em class="parameter"><code>buffer</code></em>. Will block during this read.
314
314
</p>
315
315
<p>
316
 
This function is similar to <a class="link" href="GInputStream.html#g-input-stream-read"><code class="function">g_input_stream_read()</code></a>, except it tries to
 
316
This function is similar to <a class="link" href="GInputStream.html#g-input-stream-read" title="g_input_stream_read ()"><code class="function">g_input_stream_read()</code></a>, except it tries to
317
317
read as many bytes as requested, only stopping on an error or end of stream.
318
318
</p>
319
319
<p>
320
320
On a successful read of <em class="parameter"><code>count</code></em> bytes, or if we reached the end of the
321
321
stream,  <a
322
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
322
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
323
323
><code class="literal">TRUE</code></a> is returned, and <em class="parameter"><code>bytes_read</code></em> is set to the number of bytes
324
324
read into <em class="parameter"><code>buffer</code></em>.
325
325
</p>
326
326
<p>
327
327
If there is an error during the operation <a
328
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
328
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
329
329
><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
330
330
is set to indicate the error status, <em class="parameter"><code>bytes_read</code></em> is updated to contain
331
331
the number of bytes read into <em class="parameter"><code>buffer</code></em> before the error occurred.</p>
332
332
<p>
333
 
 
334
333
</p>
335
334
<div class="variablelist"><table border="0">
336
335
<col align="left" valign="top">
337
336
<tbody>
338
337
<tr>
339
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
338
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
340
339
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
341
340
</td>
342
341
</tr>
343
342
<tr>
344
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></p></td>
 
343
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
345
344
<td> a buffer to read data into (which should be at least count bytes long).
346
345
</td>
347
346
</tr>
348
347
<tr>
349
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
348
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
350
349
<td> the number of bytes that will be read from the stream
351
350
</td>
352
351
</tr>
353
352
<tr>
354
 
<td><p><span class="term"><em class="parameter"><code>bytes_read</code></em>&#160;:</span></p></td>
 
353
<td><p><span class="term"><em class="parameter"><code>bytes_read</code></em> :</span></p></td>
355
354
<td> location to store the number of bytes that was read from the stream
356
355
</td>
357
356
</tr>
358
357
<tr>
359
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
358
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
360
359
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
361
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
360
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
362
361
><code class="literal">NULL</code></a> to ignore.
363
362
</td>
364
363
</tr>
365
364
<tr>
366
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
365
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
367
366
<td> location to store the error occuring, or <a
368
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
367
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
369
368
><code class="literal">NULL</code></a> to ignore
370
369
</td>
371
370
</tr>
372
371
<tr>
373
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
372
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
374
373
<td> <a
375
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
374
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
376
375
><code class="literal">TRUE</code></a> on success, <a
377
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
376
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
378
377
><code class="literal">FALSE</code></a> if there was an error
379
378
</td>
380
379
</tr>
383
382
</div>
384
383
<hr>
385
384
<div class="refsect2" lang="en">
386
 
<a name="id2849774"></a><h3>
387
 
<a name="g-input-stream-skip"></a>g_input_stream_skip ()</h3>
388
 
<a class="indexterm" name="id2849786"></a><pre class="programlisting"><a
 
385
<a name="g-input-stream-skip"></a><h3>g_input_stream_skip ()</h3>
 
386
<pre class="programlisting"><a
389
387
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
390
388
>gssize</a>              g_input_stream_skip                 (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
391
389
                                                         <a
399
397
Tries to skip <em class="parameter"><code>count</code></em> bytes from the stream. Will block during the operation.
400
398
</p>
401
399
<p>
402
 
This is identical to <a class="link" href="GInputStream.html#g-input-stream-read"><code class="function">g_input_stream_read()</code></a>, from a behaviour standpoint,
 
400
This is identical to <a class="link" href="GInputStream.html#g-input-stream-read" title="g_input_stream_read ()"><code class="function">g_input_stream_read()</code></a>, from a behaviour standpoint,
403
401
but the bytes that are skipped are not returned to the user. Some
404
402
streams have an implementation that is more efficient than reading the data.
405
403
</p>
409
407
</p>
410
408
<p>
411
409
If <em class="parameter"><code>cancellable</code></em> is not <a
412
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
410
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
413
411
><code class="literal">NULL</code></a>, then the operation can be cancelled by
414
412
triggering the cancellable object from another thread. If the operation
415
 
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned. If an
 
413
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED--CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned. If an
416
414
operation was partially finished when the operation was cancelled the
417
415
partial result will be returned, without an error.</p>
418
416
<p>
419
 
 
420
417
</p>
421
418
<div class="variablelist"><table border="0">
422
419
<col align="left" valign="top">
423
420
<tbody>
424
421
<tr>
425
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
422
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
426
423
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
427
424
</td>
428
425
</tr>
429
426
<tr>
430
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
427
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
431
428
<td> the number of bytes that will be skipped from the stream
432
429
</td>
433
430
</tr>
434
431
<tr>
435
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
432
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
436
433
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
437
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
434
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
438
435
><code class="literal">NULL</code></a> to ignore. 
439
436
</td>
440
437
</tr>
441
438
<tr>
442
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
439
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
443
440
<td> location to store the error occuring, or <a
444
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
441
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
445
442
><code class="literal">NULL</code></a> to ignore
446
443
</td>
447
444
</tr>
448
445
<tr>
449
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
446
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
450
447
<td> Number of bytes skipped, or -1 on error
451
448
</td>
452
449
</tr>
455
452
</div>
456
453
<hr>
457
454
<div class="refsect2" lang="en">
458
 
<a name="id2850006"></a><h3>
459
 
<a name="g-input-stream-close"></a>g_input_stream_close ()</h3>
460
 
<a class="indexterm" name="id2850017"></a><pre class="programlisting"><a
 
455
<a name="g-input-stream-close"></a><h3>g_input_stream_close ()</h3>
 
456
<pre class="programlisting"><a
461
457
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
462
458
>gboolean</a>            g_input_stream_close                (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
463
459
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
468
464
Closes the stream, releasing resources related to it.
469
465
</p>
470
466
<p>
471
 
Once the stream is closed, all other operations will return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED:CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a>.
 
467
Once the stream is closed, all other operations will return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED--CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a>.
472
468
Closing a stream multiple times will not return an error.
473
469
</p>
474
470
<p>
484
480
<p>
485
481
On failure the first error that happened will be reported, but the close
486
482
operation will finish as much as possible. A stream that failed to
487
 
close will still return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED:CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a> for all operations. Still, it
 
483
close will still return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED--CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a> for all operations. Still, it
488
484
is important to check and report the error to the user.
489
485
</p>
490
486
<p>
491
487
If <em class="parameter"><code>cancellable</code></em> is not NULL, then the operation can be cancelled by
492
488
triggering the cancellable object from another thread. If the operation
493
 
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
 
489
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED--CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
494
490
Cancelling a close will still leave the stream closed, but some streams
495
491
can use a faster close that doesn't block to e.g. check errors.</p>
496
492
<p>
497
 
 
498
493
</p>
499
494
<div class="variablelist"><table border="0">
500
495
<col align="left" valign="top">
501
496
<tbody>
502
497
<tr>
503
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
498
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
504
499
<td> A <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
505
500
</td>
506
501
</tr>
507
502
<tr>
508
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
503
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
509
504
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
510
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
505
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
511
506
><code class="literal">NULL</code></a> to ignore.
512
507
</td>
513
508
</tr>
514
509
<tr>
515
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
510
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
516
511
<td> location to store the error occuring, or <a
517
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
512
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
518
513
><code class="literal">NULL</code></a> to ignore
519
514
</td>
520
515
</tr>
521
516
<tr>
522
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
517
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
523
518
<td> <a
524
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
519
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
525
520
><code class="literal">TRUE</code></a> on success, <a
526
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
521
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
527
522
><code class="literal">FALSE</code></a> on failure
528
523
</td>
529
524
</tr>
532
527
</div>
533
528
<hr>
534
529
<div class="refsect2" lang="en">
535
 
<a name="id2850242"></a><h3>
536
 
<a name="g-input-stream-read-async"></a>g_input_stream_read_async ()</h3>
537
 
<a class="indexterm" name="id2850253"></a><pre class="programlisting">void                g_input_stream_read_async           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
530
<a name="g-input-stream-read-async"></a><h3>g_input_stream_read_async ()</h3>
 
531
<pre class="programlisting">void                g_input_stream_read_async           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
538
532
                                                         void *buffer,
539
533
                                                         <a
540
534
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
541
535
>gsize</a> count,
542
536
                                                         int io_priority,
543
537
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
544
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
538
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
545
539
                                                         <a
546
540
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
547
541
>gpointer</a> user_data);</pre>
548
542
<p>
549
543
Request an asynchronous read of <em class="parameter"><code>count</code></em> bytes from the stream into the buffer
550
544
starting at <em class="parameter"><code>buffer</code></em>. When the operation is finished <em class="parameter"><code>callback</code></em> will be called. 
551
 
You can then call <a class="link" href="GInputStream.html#g-input-stream-read-finish"><code class="function">g_input_stream_read_finish()</code></a> to get the result of the 
 
545
You can then call <a class="link" href="GInputStream.html#g-input-stream-read-finish" title="g_input_stream_read_finish ()"><code class="function">g_input_stream_read_finish()</code></a> to get the result of the 
552
546
operation.
553
547
</p>
554
548
<p>
555
549
During an async request no other sync and async calls are allowed, and will
556
 
result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING:CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a> errors. 
 
550
result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING--CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a> errors. 
557
551
</p>
558
552
<p>
559
553
A value of <em class="parameter"><code>count</code></em> larger than <a
560
 
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE:CAPS"
561
 
><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.
 
554
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE--CAPS"
 
555
><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT--CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.
562
556
</p>
563
557
<p>
564
558
On success, the number of bytes read into the buffer will be passed to the
571
565
Any outstanding i/o request with higher priority (lower numerical value) will
572
566
be executed before an outstanding request with lower priority. Default
573
567
priority is <a
574
 
href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"
 
568
href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT--CAPS"
575
569
><code class="literal">G_PRIORITY_DEFAULT</code></a>.
576
570
</p>
577
571
<p>
579
573
asynchronicity, so they are optional for inheriting classes. However, if you
580
574
override one you must override all.</p>
581
575
<p>
582
 
 
583
576
</p>
584
577
<div class="variablelist"><table border="0">
585
578
<col align="left" valign="top">
586
579
<tbody>
587
580
<tr>
588
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
581
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
589
582
<td> A <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
590
583
</td>
591
584
</tr>
592
585
<tr>
593
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></p></td>
 
586
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
594
587
<td> a buffer to read data into (which should be at least count bytes long).
595
588
</td>
596
589
</tr>
597
590
<tr>
598
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
591
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
599
592
<td> the number of bytes that will be read from the stream
600
593
</td>
601
594
</tr>
602
595
<tr>
603
 
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em>&#160;:</span></p></td>
 
596
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
604
597
<td> the <a class="link" href="gio-GIOScheduler.html#io-priority">I/O priority</a> 
605
598
of the request. 
606
599
</td>
607
600
</tr>
608
601
<tr>
609
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
602
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
610
603
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
611
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
604
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
612
605
><code class="literal">NULL</code></a> to ignore.
613
606
</td>
614
607
</tr>
615
608
<tr>
616
 
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
 
609
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
617
610
<td> callback to call when the request is satisfied
618
611
</td>
619
612
</tr>
620
613
<tr>
621
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
614
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
622
615
<td> the data to pass to callback function
623
616
</td>
624
617
</tr>
627
620
</div>
628
621
<hr>
629
622
<div class="refsect2" lang="en">
630
 
<a name="id2850573"></a><h3>
631
 
<a name="g-input-stream-read-finish"></a>g_input_stream_read_finish ()</h3>
632
 
<a class="indexterm" name="id2850585"></a><pre class="programlisting"><a
 
623
<a name="g-input-stream-read-finish"></a><h3>g_input_stream_read_finish ()</h3>
 
624
<pre class="programlisting"><a
633
625
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
634
626
>gssize</a>              g_input_stream_read_finish          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
635
627
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
639
631
<p>
640
632
Finishes an asynchronous stream read operation.</p>
641
633
<p>
642
 
 
643
634
</p>
644
635
<div class="variablelist"><table border="0">
645
636
<col align="left" valign="top">
646
637
<tbody>
647
638
<tr>
648
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
639
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
649
640
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
650
641
</td>
651
642
</tr>
652
643
<tr>
653
 
<td><p><span class="term"><em class="parameter"><code>result</code></em>&#160;:</span></p></td>
 
644
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
654
645
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
655
646
</td>
656
647
</tr>
657
648
<tr>
658
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
649
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
659
650
<td> a <a
660
651
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
661
652
><span class="type">GError</span></a> location to store the error occuring, or <a
662
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
653
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
663
654
><code class="literal">NULL</code></a> to 
664
655
ignore.
665
656
</td>
666
657
</tr>
667
658
<tr>
668
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
659
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
669
660
<td> number of bytes read in, or -1 on error.
670
661
</td>
671
662
</tr>
674
665
</div>
675
666
<hr>
676
667
<div class="refsect2" lang="en">
677
 
<a name="id2850720"></a><h3>
678
 
<a name="g-input-stream-skip-async"></a>g_input_stream_skip_async ()</h3>
679
 
<a class="indexterm" name="id2850732"></a><pre class="programlisting">void                g_input_stream_skip_async           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
668
<a name="g-input-stream-skip-async"></a><h3>g_input_stream_skip_async ()</h3>
 
669
<pre class="programlisting">void                g_input_stream_skip_async           (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
680
670
                                                         <a
681
671
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
682
672
>gsize</a> count,
683
673
                                                         int io_priority,
684
674
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
685
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
675
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
686
676
                                                         <a
687
677
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
688
678
>gpointer</a> user_data);</pre>
689
679
<p>
690
680
Request an asynchronous skip of <em class="parameter"><code>count</code></em> bytes from the stream into the buffer
691
681
starting at <em class="parameter"><code>buffer</code></em>. When the operation is finished <em class="parameter"><code>callback</code></em> will be called. 
692
 
You can then call <a class="link" href="GInputStream.html#g-input-stream-skip-finish"><code class="function">g_input_stream_skip_finish()</code></a> to get the result of the 
 
682
You can then call <a class="link" href="GInputStream.html#g-input-stream-skip-finish" title="g_input_stream_skip_finish ()"><code class="function">g_input_stream_skip_finish()</code></a> to get the result of the 
693
683
operation.
694
684
</p>
695
685
<p>
696
686
During an async request no other sync and async calls are allowed, and will
697
 
result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING:CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a> errors. 
 
687
result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING--CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a> errors. 
698
688
</p>
699
689
<p>
700
690
A value of <em class="parameter"><code>count</code></em> larger than <a
701
 
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE:CAPS"
702
 
><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.
 
691
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE--CAPS"
 
692
><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT--CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.
703
693
</p>
704
694
<p>
705
695
On success, the number of bytes skipped will be passed to the
712
702
Any outstanding i/o request with higher priority (lower numerical value) will
713
703
be executed before an outstanding request with lower priority. Default
714
704
priority is <a
715
 
href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"
 
705
href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT--CAPS"
716
706
><code class="literal">G_PRIORITY_DEFAULT</code></a>.
717
707
</p>
718
708
<p>
720
710
asynchronicity, so they are optional for inheriting classes. However, if you
721
711
override one you must override all.</p>
722
712
<p>
723
 
 
724
713
</p>
725
714
<div class="variablelist"><table border="0">
726
715
<col align="left" valign="top">
727
716
<tbody>
728
717
<tr>
729
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
718
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
730
719
<td> A <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
731
720
</td>
732
721
</tr>
733
722
<tr>
734
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
723
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
735
724
<td> the number of bytes that will be skipped from the stream
736
725
</td>
737
726
</tr>
738
727
<tr>
739
 
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em>&#160;:</span></p></td>
 
728
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
740
729
<td> the <a class="link" href="gio-GIOScheduler.html#io-priority">I/O priority</a> 
741
730
of the request. 
742
731
</td>
743
732
</tr>
744
733
<tr>
745
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
734
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
746
735
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
747
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
736
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
748
737
><code class="literal">NULL</code></a> to ignore. 
749
738
</td>
750
739
</tr>
751
740
<tr>
752
 
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
 
741
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
753
742
<td> callback to call when the request is satisfied
754
743
</td>
755
744
</tr>
756
745
<tr>
757
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
746
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
758
747
<td> the data to pass to callback function
759
748
</td>
760
749
</tr>
763
752
</div>
764
753
<hr>
765
754
<div class="refsect2" lang="en">
766
 
<a name="id2851032"></a><h3>
767
 
<a name="g-input-stream-skip-finish"></a>g_input_stream_skip_finish ()</h3>
768
 
<a class="indexterm" name="id2851044"></a><pre class="programlisting"><a
 
755
<a name="g-input-stream-skip-finish"></a><h3>g_input_stream_skip_finish ()</h3>
 
756
<pre class="programlisting"><a
769
757
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
770
758
>gssize</a>              g_input_stream_skip_finish          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
771
759
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
775
763
<p>
776
764
Finishes a stream skip operation.</p>
777
765
<p>
778
 
 
779
766
</p>
780
767
<div class="variablelist"><table border="0">
781
768
<col align="left" valign="top">
782
769
<tbody>
783
770
<tr>
784
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
771
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
785
772
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
786
773
</td>
787
774
</tr>
788
775
<tr>
789
 
<td><p><span class="term"><em class="parameter"><code>result</code></em>&#160;:</span></p></td>
 
776
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
790
777
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
791
778
</td>
792
779
</tr>
793
780
<tr>
794
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
781
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
795
782
<td> a <a
796
783
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
797
784
><span class="type">GError</span></a> location to store the error occuring, or <a
798
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
785
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
799
786
><code class="literal">NULL</code></a> to 
800
787
ignore.
801
788
</td>
802
789
</tr>
803
790
<tr>
804
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
791
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
805
792
<td> the size of the bytes skipped, or <code class="literal">-1</code> on error.
806
793
</td>
807
794
</tr>
810
797
</div>
811
798
<hr>
812
799
<div class="refsect2" lang="en">
813
 
<a name="id2851188"></a><h3>
814
 
<a name="g-input-stream-close-async"></a>g_input_stream_close_async ()</h3>
815
 
<a class="indexterm" name="id2851200"></a><pre class="programlisting">void                g_input_stream_close_async          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
 
800
<a name="g-input-stream-close-async"></a><h3>g_input_stream_close_async ()</h3>
 
801
<pre class="programlisting">void                g_input_stream_close_async          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
816
802
                                                         int io_priority,
817
803
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
818
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
804
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
819
805
                                                         <a
820
806
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
821
807
>gpointer</a> user_data);</pre>
822
808
<p>
823
809
Requests an asynchronous closes of the stream, releasing resources related to it.
824
810
When the operation is finished <em class="parameter"><code>callback</code></em> will be called. 
825
 
You can then call <a class="link" href="GInputStream.html#g-input-stream-close-finish"><code class="function">g_input_stream_close_finish()</code></a> to get the result of the 
 
811
You can then call <a class="link" href="GInputStream.html#g-input-stream-close-finish" title="g_input_stream_close_finish ()"><code class="function">g_input_stream_close_finish()</code></a> to get the result of the 
826
812
operation.
827
813
</p>
828
814
<p>
829
 
For behaviour details see <a class="link" href="GInputStream.html#g-input-stream-close"><code class="function">g_input_stream_close()</code></a>.
 
815
For behaviour details see <a class="link" href="GInputStream.html#g-input-stream-close" title="g_input_stream_close ()"><code class="function">g_input_stream_close()</code></a>.
830
816
</p>
831
817
<p>
832
818
The asyncronous methods have a default fallback that uses threads to implement
833
819
asynchronicity, so they are optional for inheriting classes. However, if you
834
820
override one you must override all.</p>
835
821
<p>
836
 
 
837
822
</p>
838
823
<div class="variablelist"><table border="0">
839
824
<col align="left" valign="top">
840
825
<tbody>
841
826
<tr>
842
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
827
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
843
828
<td> A <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
844
829
</td>
845
830
</tr>
846
831
<tr>
847
 
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em>&#160;:</span></p></td>
 
832
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
848
833
<td> the <a class="link" href="gio-GIOScheduler.html#io-priority">I/O priority</a> 
849
834
of the request. 
850
835
</td>
851
836
</tr>
852
837
<tr>
853
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
838
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
854
839
<td> optional cancellable object
855
840
</td>
856
841
</tr>
857
842
<tr>
858
 
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
 
843
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
859
844
<td> callback to call when the request is satisfied
860
845
</td>
861
846
</tr>
862
847
<tr>
863
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
848
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
864
849
<td> the data to pass to callback function
865
850
</td>
866
851
</tr>
869
854
</div>
870
855
<hr>
871
856
<div class="refsect2" lang="en">
872
 
<a name="id2853090"></a><h3>
873
 
<a name="g-input-stream-close-finish"></a>g_input_stream_close_finish ()</h3>
874
 
<a class="indexterm" name="id2853101"></a><pre class="programlisting"><a
 
857
<a name="g-input-stream-close-finish"></a><h3>g_input_stream_close_finish ()</h3>
 
858
<pre class="programlisting"><a
875
859
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
876
860
>gboolean</a>            g_input_stream_close_finish         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
877
861
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
879
863
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
880
864
>GError</a> **error);</pre>
881
865
<p>
882
 
Finishes closing a stream asynchronously, started from <a class="link" href="GInputStream.html#g-input-stream-close-async"><code class="function">g_input_stream_close_async()</code></a>.</p>
 
866
Finishes closing a stream asynchronously, started from <a class="link" href="GInputStream.html#g-input-stream-close-async" title="g_input_stream_close_async ()"><code class="function">g_input_stream_close_async()</code></a>.</p>
883
867
<p>
884
 
 
885
868
</p>
886
869
<div class="variablelist"><table border="0">
887
870
<col align="left" valign="top">
888
871
<tbody>
889
872
<tr>
890
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
873
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
891
874
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
892
875
</td>
893
876
</tr>
894
877
<tr>
895
 
<td><p><span class="term"><em class="parameter"><code>result</code></em>&#160;:</span></p></td>
 
878
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
896
879
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
897
880
</td>
898
881
</tr>
899
882
<tr>
900
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
883
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
901
884
<td> a <a
902
885
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
903
886
><span class="type">GError</span></a> location to store the error occuring, or <a
904
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
887
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
905
888
><code class="literal">NULL</code></a> to 
906
889
ignore.
907
890
</td>
908
891
</tr>
909
892
<tr>
910
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
893
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
911
894
<td> <a
912
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
895
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
913
896
><code class="literal">TRUE</code></a> if the stream was closed successfully.
914
897
</td>
915
898
</tr>
918
901
</div>
919
902
<hr>
920
903
<div class="refsect2" lang="en">
921
 
<a name="id2853240"></a><h3>
922
 
<a name="g-input-stream-is-closed"></a>g_input_stream_is_closed ()</h3>
923
 
<a class="indexterm" name="id2853250"></a><pre class="programlisting"><a
 
904
<a name="g-input-stream-is-closed"></a><h3>g_input_stream_is_closed ()</h3>
 
905
<pre class="programlisting"><a
924
906
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
925
907
>gboolean</a>            g_input_stream_is_closed            (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);</pre>
926
908
<p>
927
909
Checks if an input stream is closed.</p>
928
910
<p>
929
 
 
930
911
</p>
931
912
<div class="variablelist"><table border="0">
932
913
<col align="left" valign="top">
933
914
<tbody>
934
915
<tr>
935
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
916
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
936
917
<td> input stream.
937
918
</td>
938
919
</tr>
939
920
<tr>
940
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
921
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
941
922
<td> <a
942
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
923
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
943
924
><code class="literal">TRUE</code></a> if the stream is closed.
944
925
</td>
945
926
</tr>
948
929
</div>
949
930
<hr>
950
931
<div class="refsect2" lang="en">
951
 
<a name="id2853313"></a><h3>
952
 
<a name="g-input-stream-has-pending"></a>g_input_stream_has_pending ()</h3>
953
 
<a class="indexterm" name="id2853324"></a><pre class="programlisting"><a
 
932
<a name="g-input-stream-has-pending"></a><h3>g_input_stream_has_pending ()</h3>
 
933
<pre class="programlisting"><a
954
934
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
955
935
>gboolean</a>            g_input_stream_has_pending          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);</pre>
956
936
<p>
957
937
Checks if an input stream has pending actions.</p>
958
938
<p>
959
 
 
960
939
</p>
961
940
<div class="variablelist"><table border="0">
962
941
<col align="left" valign="top">
963
942
<tbody>
964
943
<tr>
965
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
944
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
966
945
<td> input stream.
967
946
</td>
968
947
</tr>
969
948
<tr>
970
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
949
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
971
950
<td> <a
972
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
951
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
973
952
><code class="literal">TRUE</code></a> if <em class="parameter"><code>stream</code></em> has pending actions.
974
953
</td>
975
954
</tr>
978
957
</div>
979
958
<hr>
980
959
<div class="refsect2" lang="en">
981
 
<a name="id2853392"></a><h3>
982
 
<a name="g-input-stream-set-pending"></a>g_input_stream_set_pending ()</h3>
983
 
<a class="indexterm" name="id2853403"></a><pre class="programlisting"><a
 
960
<a name="g-input-stream-set-pending"></a><h3>g_input_stream_set_pending ()</h3>
 
961
<pre class="programlisting"><a
984
962
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
985
963
>gboolean</a>            g_input_stream_set_pending          (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream,
986
964
                                                         <a
989
967
<p>
990
968
Sets <em class="parameter"><code>stream</code></em> to have actions pending. If the pending flag is
991
969
already set or <em class="parameter"><code>stream</code></em> is closed, it will return <a
992
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
970
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
993
971
><code class="literal">FALSE</code></a> and set
994
972
<em class="parameter"><code>error</code></em>.</p>
995
973
<p>
996
 
 
997
974
</p>
998
975
<div class="variablelist"><table border="0">
999
976
<col align="left" valign="top">
1000
977
<tbody>
1001
978
<tr>
1002
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
979
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
1003
980
<td> input stream
1004
981
</td>
1005
982
</tr>
1006
983
<tr>
1007
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
984
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1008
985
<td> a <a
1009
986
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
1010
987
><span class="type">GError</span></a> location to store the error occuring, or <a
1011
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
988
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
1012
989
><code class="literal">NULL</code></a> to 
1013
990
ignore.
1014
991
</td>
1015
992
</tr>
1016
993
<tr>
1017
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
994
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1018
995
<td> <a
1019
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
996
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
1020
997
><code class="literal">TRUE</code></a> if pending was previously unset and is now set.
1021
998
</td>
1022
999
</tr>
1025
1002
</div>
1026
1003
<hr>
1027
1004
<div class="refsect2" lang="en">
1028
 
<a name="id2853525"></a><h3>
1029
 
<a name="g-input-stream-clear-pending"></a>g_input_stream_clear_pending ()</h3>
1030
 
<a class="indexterm" name="id2853537"></a><pre class="programlisting">void                g_input_stream_clear_pending        (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);</pre>
 
1005
<a name="g-input-stream-clear-pending"></a><h3>g_input_stream_clear_pending ()</h3>
 
1006
<pre class="programlisting">void                g_input_stream_clear_pending        (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);</pre>
1031
1007
<p>
1032
1008
Clears the pending flag on <em class="parameter"><code>stream</code></em>.</p>
1033
1009
<p>
1034
 
 
1035
1010
</p>
1036
1011
<div class="variablelist"><table border="0">
1037
1012
<col align="left" valign="top">
1038
1013
<tbody><tr>
1039
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
1014
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
1040
1015
<td> input stream
1041
1016
</td>
1042
1017
</tr></tbody>
1043
1018
</table></div>
1044
1019
</div>
1045
1020
</div>
1046
 
<div class="refsect1" lang="en">
1047
 
<a name="id2853589"></a><div class="refsect2" lang="en"><a name="id2853590"></a></div>
 
1021
</div>
 
1022
<div class="footer">
1048
1023
<hr>
1049
 
<div class="refsect2" lang="en"><a name="id2853591"></a></div>
1050
 
</div>
1051
 
</div>
 
1024
          Generated by GTK-Doc V1.11</div>
1052
1025
</body>
1053
1026
</html>