← 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/GBufferedInputStream.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/GBufferedInputStream.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>GBufferedInputStream</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="GMemoryOutputStream.html" title="GMemoryOutputStream">
10
10
<link rel="next" href="GBufferedOutputStream.html" title="GBufferedOutputStream">
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="GBufferedOutputStream.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="#id2808717" class="shortcut">Top</a>
44
 
                  &#160;|&#160;
45
 
                  <a href="#id2858845" class="shortcut">Description</a>
46
 
                  &#160;|&#160;
47
 
                  <a href="#id2856963" class="shortcut">Object Hierarchy</a>
48
 
                  &#160;|&#160;
49
 
                  <a href="#id2858814" class="shortcut">Properties</a></nobr></td></tr>
 
44
<tr><td colspan="5" class="shortcuts">
 
45
<a href="#GBufferedInputStream.synopsis" class="shortcut">Top</a>
 
46
                 | 
 
47
                <a href="#GBufferedInputStream.description" class="shortcut">Description</a>
 
48
                 | 
 
49
                <a href="#GBufferedInputStream.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
50
                 | 
 
51
                <a href="#GBufferedInputStream.properties" class="shortcut">Properties</a>
 
52
</td></tr>
50
53
</table>
51
54
<div class="refentry" lang="en">
52
55
<a name="GBufferedInputStream"></a><div class="titlepage"></div>
53
56
<div class="refnamediv"><table width="100%"><tr>
54
57
<td valign="top">
55
 
<h2>
56
 
<a name="id2808717"></a><span class="refentrytitle">GBufferedInputStream</span>
57
 
</h2>
58
 
<p>GBufferedInputStream &#8212; Buffered Input Stream</p>
 
58
<h2><span class="refentrytitle"><a name="GBufferedInputStream.top_of_page"></a>GBufferedInputStream</span></h2>
 
59
<p>GBufferedInputStream — Buffered Input Stream</p>
59
60
</td>
60
61
<td valign="top" align="right"></td>
61
62
</tr></table></div>
62
63
<div class="refsynopsisdiv">
63
 
<h2>Synopsis</h2>
 
64
<a name="GBufferedInputStream.synopsis"></a><h2>Synopsis</h2>
64
65
<pre class="synopsis">
65
66
 
66
67
#include &lt;gio/gio.h&gt;
67
68
 
68
 
 
69
 
                    <a class="link" href="GBufferedInputStream.html#GBufferedInputStream-struct">GBufferedInputStream</a>;
70
 
<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new">g_buffered_input_stream_new</a>         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream);
71
 
<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new-sized">g_buffered_input_stream_new_sized</a>   (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream,
 
69
                    <a class="link" href="GBufferedInputStream.html#GBufferedInputStream-struct" title="GBufferedInputStream">GBufferedInputStream</a>;
 
70
<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new" title="g_buffered_input_stream_new ()">g_buffered_input_stream_new</a>         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream);
 
71
<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new-sized" title="g_buffered_input_stream_new_sized ()">g_buffered_input_stream_new_sized</a>   (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream,
72
72
                                                         <a
73
73
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
74
74
>gsize</a> size);
75
75
<a
76
76
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
77
 
>gsize</a>               <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-buffer-size">g_buffered_input_stream_get_buffer_size</a>
 
77
>gsize</a>               <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-buffer-size" title="g_buffered_input_stream_get_buffer_size ()">g_buffered_input_stream_get_buffer_size</a>
78
78
                                                        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream);
79
 
void                <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-set-buffer-size">g_buffered_input_stream_set_buffer_size</a>
 
79
void                <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-set-buffer-size" title="g_buffered_input_stream_set_buffer_size ()">g_buffered_input_stream_set_buffer_size</a>
80
80
                                                        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
81
81
                                                         <a
82
82
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
83
83
>gsize</a> size);
84
84
<a
85
85
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
86
 
>gsize</a>               <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-available">g_buffered_input_stream_get_available</a>
 
86
>gsize</a>               <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-available" title="g_buffered_input_stream_get_available ()">g_buffered_input_stream_get_available</a>
87
87
                                                        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream);
88
 
const void*         <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-peek-buffer">g_buffered_input_stream_peek_buffer</a> (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
88
const void*         <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-peek-buffer" title="g_buffered_input_stream_peek_buffer ()">g_buffered_input_stream_peek_buffer</a> (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
89
89
                                                         <a
90
90
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
91
91
>gsize</a> *count);
92
92
<a
93
93
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
94
 
>gsize</a>               <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-peek">g_buffered_input_stream_peek</a>        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
94
>gsize</a>               <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-peek" title="g_buffered_input_stream_peek ()">g_buffered_input_stream_peek</a>        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
95
95
                                                         void *buffer,
96
96
                                                         <a
97
97
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
101
101
>gsize</a> count);
102
102
<a
103
103
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
104
 
>gssize</a>              <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill">g_buffered_input_stream_fill</a>        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
104
>gssize</a>              <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill" title="g_buffered_input_stream_fill ()">g_buffered_input_stream_fill</a>        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
105
105
                                                         <a
106
106
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
107
107
>gssize</a> count,
109
109
                                                         <a
110
110
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
111
111
>GError</a> **error);
112
 
void                <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-async">g_buffered_input_stream_fill_async</a>  (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
112
void                <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-async" title="g_buffered_input_stream_fill_async ()">g_buffered_input_stream_fill_async</a>  (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
113
113
                                                         <a
114
114
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
115
115
>gssize</a> count,
116
116
                                                         int io_priority,
117
117
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
118
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
118
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
119
119
                                                         <a
120
120
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
121
121
>gpointer</a> user_data);
122
122
<a
123
123
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
124
 
>gssize</a>              <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-finish">g_buffered_input_stream_fill_finish</a> (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
124
>gssize</a>              <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-finish" title="g_buffered_input_stream_fill_finish ()">g_buffered_input_stream_fill_finish</a> (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
125
125
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
126
126
                                                         <a
127
127
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
128
128
>GError</a> **error);
129
 
int                 <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-read-byte">g_buffered_input_stream_read_byte</a>   (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
129
int                 <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-read-byte" title="g_buffered_input_stream_read_byte ()">g_buffered_input_stream_read_byte</a>   (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
130
130
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
131
131
                                                         <a
132
132
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
133
133
>GError</a> **error);
134
 
 
135
 
 
136
134
</pre>
137
135
</div>
138
136
<div class="refsect1" lang="en">
139
 
<a name="id2856963"></a><h2>Object Hierarchy</h2>
 
137
<a name="GBufferedInputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
140
138
<pre class="synopsis">
141
 
 
142
139
  <a
143
140
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
144
141
>GObject</a>
149
146
</pre>
150
147
</div>
151
148
<div class="refsect1" lang="en">
152
 
<a name="id2858814"></a><h2>Properties</h2>
 
149
<a name="GBufferedInputStream.properties"></a><h2>Properties</h2>
153
150
<pre class="synopsis">
154
 
 
155
 
  "<a class="link" href="GBufferedInputStream.html#GBufferedInputStream--buffer-size">buffer-size</a>"              <a
 
151
  "<a class="link" href="GBufferedInputStream.html#GBufferedInputStream--buffer-size" title='The "buffer-size" property'>buffer-size</a>"              <a
156
152
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
157
153
>guint</a>                 : Read / Write / Construct
158
154
</pre>
159
155
</div>
160
156
<div class="refsect1" lang="en">
161
 
<a name="id2858845"></a><h2>Description</h2>
 
157
<a name="GBufferedInputStream.description"></a><h2>Description</h2>
162
158
<p>
163
159
Buffered input stream implements <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> and provides 
164
160
for buffered reads. 
167
163
By default, <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>'s buffer size is set at 4 kilobytes.
168
164
</p>
169
165
<p>
170
 
To create a buffered input stream, use <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new"><code class="function">g_buffered_input_stream_new()</code></a>, 
171
 
or <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new-sized"><code class="function">g_buffered_input_stream_new_sized()</code></a> to specify the buffer's size at 
 
166
To create a buffered input stream, use <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new" title="g_buffered_input_stream_new ()"><code class="function">g_buffered_input_stream_new()</code></a>, 
 
167
or <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-new-sized" title="g_buffered_input_stream_new_sized ()"><code class="function">g_buffered_input_stream_new_sized()</code></a> to specify the buffer's size at 
172
168
construction.
173
169
</p>
174
170
<p>
175
171
To get the size of a buffer within a buffered input stream, use 
176
 
<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-buffer-size"><code class="function">g_buffered_input_stream_get_buffer_size()</code></a>. To change the size of a 
 
172
<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-buffer-size" title="g_buffered_input_stream_get_buffer_size ()"><code class="function">g_buffered_input_stream_get_buffer_size()</code></a>. To change the size of a 
177
173
buffered input stream's buffer, use
178
 
<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-set-buffer-size"><code class="function">g_buffered_input_stream_set_buffer_size()</code></a>. Note that the buffer's size 
 
174
<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-set-buffer-size" title="g_buffered_input_stream_set_buffer_size ()"><code class="function">g_buffered_input_stream_set_buffer_size()</code></a>. Note that the buffer's size 
179
175
cannot be reduced below the size of the data within the buffer.</p>
180
176
<p>
181
 
 
182
177
</p>
183
178
</div>
184
179
<div class="refsect1" lang="en">
185
 
<a name="id2858933"></a><h2>Details</h2>
 
180
<a name="GBufferedInputStream.details"></a><h2>Details</h2>
186
181
<div class="refsect2" lang="en">
187
 
<a name="id2858944"></a><h3>
188
 
<a name="GBufferedInputStream-struct"></a>GBufferedInputStream</h3>
189
 
<a class="indexterm" name="id2858955"></a><pre class="programlisting">typedef struct _GBufferedInputStream GBufferedInputStream;</pre>
 
182
<a name="GBufferedInputStream-struct"></a><h3>GBufferedInputStream</h3>
 
183
<pre class="programlisting">typedef struct _GBufferedInputStream GBufferedInputStream;</pre>
190
184
<p>
191
185
Implements <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> with a sized input buffer.</p>
192
186
<p>
193
 
 
194
187
</p>
195
188
</div>
196
189
<hr>
197
190
<div class="refsect2" lang="en">
198
 
<a name="id2858982"></a><h3>
199
 
<a name="g-buffered-input-stream-new"></a>g_buffered_input_stream_new ()</h3>
200
 
<a class="indexterm" name="id2858994"></a><pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       g_buffered_input_stream_new         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream);</pre>
 
191
<a name="g-buffered-input-stream-new"></a><h3>g_buffered_input_stream_new ()</h3>
 
192
<pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       g_buffered_input_stream_new         (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream);</pre>
201
193
<p>
202
194
Creates a new <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> from the given <em class="parameter"><code>base_stream</code></em>, with 
203
195
a buffer set to the default size (4 kilobytes).</p>
204
196
<p>
205
 
 
206
197
</p>
207
198
<div class="variablelist"><table border="0">
208
199
<col align="left" valign="top">
209
200
<tbody>
210
201
<tr>
211
 
<td><p><span class="term"><em class="parameter"><code>base_stream</code></em>&#160;:</span></p></td>
 
202
<td><p><span class="term"><em class="parameter"><code>base_stream</code></em> :</span></p></td>
212
203
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
213
204
</td>
214
205
</tr>
215
206
<tr>
216
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217
208
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> for the given <em class="parameter"><code>base_stream</code></em>.
218
209
</td>
219
210
</tr>
222
213
</div>
223
214
<hr>
224
215
<div class="refsect2" lang="en">
225
 
<a name="id2861303"></a><h3>
226
 
<a name="g-buffered-input-stream-new-sized"></a>g_buffered_input_stream_new_sized ()</h3>
227
 
<a class="indexterm" name="id2861316"></a><pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       g_buffered_input_stream_new_sized   (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream,
 
216
<a name="g-buffered-input-stream-new-sized"></a><h3>g_buffered_input_stream_new_sized ()</h3>
 
217
<pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       g_buffered_input_stream_new_sized   (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream,
228
218
                                                         <a
229
219
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
230
220
>gsize</a> size);</pre>
232
222
Creates a new <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a> from the given <em class="parameter"><code>base_stream</code></em>, 
233
223
with a buffer set to <em class="parameter"><code>size</code></em>.</p>
234
224
<p>
235
 
 
236
225
</p>
237
226
<div class="variablelist"><table border="0">
238
227
<col align="left" valign="top">
239
228
<tbody>
240
229
<tr>
241
 
<td><p><span class="term"><em class="parameter"><code>base_stream</code></em>&#160;:</span></p></td>
 
230
<td><p><span class="term"><em class="parameter"><code>base_stream</code></em> :</span></p></td>
242
231
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
243
232
</td>
244
233
</tr>
245
234
<tr>
246
 
<td><p><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></p></td>
 
235
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
247
236
<td> a <a
248
237
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
249
238
><span class="type">gsize</span></a>.
250
239
</td>
251
240
</tr>
252
241
<tr>
253
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
242
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
254
243
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
255
244
</td>
256
245
</tr>
259
248
</div>
260
249
<hr>
261
250
<div class="refsect2" lang="en">
262
 
<a name="id2861438"></a><h3>
263
 
<a name="g-buffered-input-stream-get-buffer-size"></a>g_buffered_input_stream_get_buffer_size ()</h3>
264
 
<a class="indexterm" name="id2861452"></a><pre class="programlisting"><a
 
251
<a name="g-buffered-input-stream-get-buffer-size"></a><h3>g_buffered_input_stream_get_buffer_size ()</h3>
 
252
<pre class="programlisting"><a
265
253
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
266
254
>gsize</a>               g_buffered_input_stream_get_buffer_size
267
255
                                                        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream);</pre>
268
256
<p>
269
257
Gets the size of the input buffer.</p>
270
258
<p>
271
 
 
272
259
</p>
273
260
<div class="variablelist"><table border="0">
274
261
<col align="left" valign="top">
275
262
<tbody>
276
263
<tr>
277
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
264
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
278
265
<td> <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
279
266
</td>
280
267
</tr>
281
268
<tr>
282
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
269
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
283
270
<td> the current buffer size.
284
271
</td>
285
272
</tr>
288
275
</div>
289
276
<hr>
290
277
<div class="refsect2" lang="en">
291
 
<a name="id2861520"></a><h3>
292
 
<a name="g-buffered-input-stream-set-buffer-size"></a>g_buffered_input_stream_set_buffer_size ()</h3>
293
 
<a class="indexterm" name="id2861534"></a><pre class="programlisting">void                g_buffered_input_stream_set_buffer_size
 
278
<a name="g-buffered-input-stream-set-buffer-size"></a><h3>g_buffered_input_stream_set_buffer_size ()</h3>
 
279
<pre class="programlisting">void                g_buffered_input_stream_set_buffer_size
294
280
                                                        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
295
281
                                                         <a
296
282
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
300
286
size of the contents of the buffer. The buffer can never be resized 
301
287
smaller than its current contents.</p>
302
288
<p>
303
 
 
304
289
</p>
305
290
<div class="variablelist"><table border="0">
306
291
<col align="left" valign="top">
307
292
<tbody>
308
293
<tr>
309
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
294
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
310
295
<td> <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
311
296
</td>
312
297
</tr>
313
298
<tr>
314
 
<td><p><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></p></td>
 
299
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
315
300
<td> a <a
316
301
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
317
302
><span class="type">gsize</span></a>.
322
307
</div>
323
308
<hr>
324
309
<div class="refsect2" lang="en">
325
 
<a name="id2861634"></a><h3>
326
 
<a name="g-buffered-input-stream-get-available"></a>g_buffered_input_stream_get_available ()</h3>
327
 
<a class="indexterm" name="id2861647"></a><pre class="programlisting"><a
 
310
<a name="g-buffered-input-stream-get-available"></a><h3>g_buffered_input_stream_get_available ()</h3>
 
311
<pre class="programlisting"><a
328
312
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
329
313
>gsize</a>               g_buffered_input_stream_get_available
330
314
                                                        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream);</pre>
331
315
<p>
332
316
Gets the size of the available data within the stream.</p>
333
317
<p>
334
 
 
335
318
</p>
336
319
<div class="variablelist"><table border="0">
337
320
<col align="left" valign="top">
338
321
<tbody>
339
322
<tr>
340
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
323
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
341
324
<td> <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
342
325
</td>
343
326
</tr>
344
327
<tr>
345
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
328
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
346
329
<td> size of the available stream. 
347
330
</td>
348
331
</tr>
351
334
</div>
352
335
<hr>
353
336
<div class="refsect2" lang="en">
354
 
<a name="id2861716"></a><h3>
355
 
<a name="g-buffered-input-stream-peek-buffer"></a>g_buffered_input_stream_peek_buffer ()</h3>
356
 
<a class="indexterm" name="id2861730"></a><pre class="programlisting">const void*         g_buffered_input_stream_peek_buffer (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
337
<a name="g-buffered-input-stream-peek-buffer"></a><h3>g_buffered_input_stream_peek_buffer ()</h3>
 
338
<pre class="programlisting">const void*         g_buffered_input_stream_peek_buffer (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
357
339
                                                         <a
358
340
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
359
341
>gsize</a> *count);</pre>
362
344
buffer must not be modified and will become invalid when reading from
363
345
the stream or filling the buffer.</p>
364
346
<p>
365
 
 
366
347
</p>
367
348
<div class="variablelist"><table border="0">
368
349
<col align="left" valign="top">
369
350
<tbody>
370
351
<tr>
371
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
352
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
372
353
<td> a <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
373
354
</td>
374
355
</tr>
375
356
<tr>
376
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
357
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
377
358
<td> a <a
378
359
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
379
360
><span class="type">gsize</span></a> to get the number of bytes available in the buffer.
380
361
</td>
381
362
</tr>
382
363
<tr>
383
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
364
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
384
365
<td> read-only buffer
385
366
</td>
386
367
</tr>
389
370
</div>
390
371
<hr>
391
372
<div class="refsect2" lang="en">
392
 
<a name="id2861830"></a><h3>
393
 
<a name="g-buffered-input-stream-peek"></a>g_buffered_input_stream_peek ()</h3>
394
 
<a class="indexterm" name="id2861843"></a><pre class="programlisting"><a
 
373
<a name="g-buffered-input-stream-peek"></a><h3>g_buffered_input_stream_peek ()</h3>
 
374
<pre class="programlisting"><a
395
375
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
396
376
>gsize</a>               g_buffered_input_stream_peek        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
397
377
                                                         void *buffer,
405
385
Peeks in the buffer, copying data of size <em class="parameter"><code>count</code></em> into <em class="parameter"><code>buffer</code></em>, 
406
386
offset <em class="parameter"><code>offset</code></em> bytes.</p>
407
387
<p>
408
 
 
409
388
</p>
410
389
<div class="variablelist"><table border="0">
411
390
<col align="left" valign="top">
412
391
<tbody>
413
392
<tr>
414
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
393
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
415
394
<td> a <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
416
395
</td>
417
396
</tr>
418
397
<tr>
419
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></p></td>
 
398
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
420
399
<td> a pointer to an allocated chunk of memory.
421
400
</td>
422
401
</tr>
423
402
<tr>
424
 
<td><p><span class="term"><em class="parameter"><code>offset</code></em>&#160;:</span></p></td>
425
 
<td> a <a
426
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
427
 
><span class="type">gsize</span></a>.
428
 
</td>
429
 
</tr>
430
 
<tr>
431
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
432
 
<td> a <a
433
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
434
 
><span class="type">gsize</span></a>.
435
 
</td>
436
 
</tr>
437
 
<tr>
438
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
403
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 
404
<td> a <a
 
405
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
 
406
><span class="type">gsize</span></a>.
 
407
</td>
 
408
</tr>
 
409
<tr>
 
410
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
 
411
<td> a <a
 
412
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
 
413
><span class="type">gsize</span></a>.
 
414
</td>
 
415
</tr>
 
416
<tr>
 
417
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
439
418
<td> a <a
440
419
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"
441
420
><span class="type">gsize</span></a> of the number of bytes peeked, or <code class="literal">-1</code> on error.
446
425
</div>
447
426
<hr>
448
427
<div class="refsect2" lang="en">
449
 
<a name="id2862023"></a><h3>
450
 
<a name="g-buffered-input-stream-fill"></a>g_buffered_input_stream_fill ()</h3>
451
 
<a class="indexterm" name="id2862036"></a><pre class="programlisting"><a
 
428
<a name="g-buffered-input-stream-fill"></a><h3>g_buffered_input_stream_fill ()</h3>
 
429
<pre class="programlisting"><a
452
430
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
453
431
>gssize</a>              g_buffered_input_stream_fill        (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
454
432
                                                         <a
465
443
<p>
466
444
If <em class="parameter"><code>count</code></em> is zero, returns zero and does nothing. A value of <em class="parameter"><code>count</code></em>
467
445
larger than <a
468
 
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE:CAPS"
469
 
><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.
 
446
href="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE--CAPS"
 
447
><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.
470
448
</p>
471
449
<p>
472
450
On success, the number of bytes read into the buffer is returned.
476
454
</p>
477
455
<p>
478
456
If <em class="parameter"><code>cancellable</code></em> is not <a
479
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
457
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
480
458
><code class="literal">NULL</code></a>, then the operation can be cancelled by
481
459
triggering the cancellable object from another thread. If the operation
482
 
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
 
460
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
483
461
operation was partially finished when the operation was cancelled the
484
462
partial result will be returned, without an error.
485
463
</p>
488
466
</p>
489
467
<p>
490
468
For the asynchronous, non-blocking, version of this function, see 
491
 
<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-async"><code class="function">g_buffered_input_stream_fill_async()</code></a>.</p>
 
469
<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-async" title="g_buffered_input_stream_fill_async ()"><code class="function">g_buffered_input_stream_fill_async()</code></a>.</p>
492
470
<p>
493
 
 
494
471
</p>
495
472
<div class="variablelist"><table border="0">
496
473
<col align="left" valign="top">
497
474
<tbody>
498
475
<tr>
499
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
476
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
500
477
<td> <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
501
478
</td>
502
479
</tr>
503
480
<tr>
504
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
481
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
505
482
<td> the number of bytes that will be read from the stream.
506
483
</td>
507
484
</tr>
508
485
<tr>
509
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
486
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
510
487
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
511
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
488
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
512
489
><code class="literal">NULL</code></a> to ignore.
513
490
</td>
514
491
</tr>
515
492
<tr>
516
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
493
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
517
494
<td> location to store the error occuring, or <a
518
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
495
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
519
496
><code class="literal">NULL</code></a> to ignore.
520
497
</td>
521
498
</tr>
522
499
<tr>
523
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
500
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
524
501
<td> the number of bytes read into <em class="parameter"><code>stream</code></em>'s buffer, up to <em class="parameter"><code>count</code></em>, 
525
502
    or -1 on error.
526
503
</td>
530
507
</div>
531
508
<hr>
532
509
<div class="refsect2" lang="en">
533
 
<a name="id2862321"></a><h3>
534
 
<a name="g-buffered-input-stream-fill-async"></a>g_buffered_input_stream_fill_async ()</h3>
535
 
<a class="indexterm" name="id2862335"></a><pre class="programlisting">void                g_buffered_input_stream_fill_async  (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
510
<a name="g-buffered-input-stream-fill-async"></a><h3>g_buffered_input_stream_fill_async ()</h3>
 
511
<pre class="programlisting">void                g_buffered_input_stream_fill_async  (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
536
512
                                                         <a
537
513
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
538
514
>gssize</a> count,
539
515
                                                         int io_priority,
540
516
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
541
 
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
 
517
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback,
542
518
                                                         <a
543
519
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
544
520
>gpointer</a> user_data);</pre>
545
521
<p>
546
522
Reads data into <em class="parameter"><code>stream</code></em>'s buffer asynchronously, up to <em class="parameter"><code>count</code></em> size.
547
523
<em class="parameter"><code>io_priority</code></em> can be used to prioritize reads. For the synchronous
548
 
version of this function, see <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill"><code class="function">g_buffered_input_stream_fill()</code></a>.</p>
 
524
version of this function, see <a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill" title="g_buffered_input_stream_fill ()"><code class="function">g_buffered_input_stream_fill()</code></a>.</p>
549
525
<p>
550
 
 
551
526
</p>
552
527
<div class="variablelist"><table border="0">
553
528
<col align="left" valign="top">
554
529
<tbody>
555
530
<tr>
556
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
531
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
557
532
<td> <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
558
533
</td>
559
534
</tr>
560
535
<tr>
561
 
<td><p><span class="term"><em class="parameter"><code>count</code></em>&#160;:</span></p></td>
 
536
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
562
537
<td> a <a
563
538
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
564
539
><span class="type">gssize</span></a>.
565
540
</td>
566
541
</tr>
567
542
<tr>
568
 
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em>&#160;:</span></p></td>
 
543
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
569
544
<td> the <a class="link" href="gio-GIOScheduler.html#io-priority">I/O priority</a> 
570
545
    of the request.
571
546
</td>
572
547
</tr>
573
548
<tr>
574
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
549
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
575
550
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object
576
551
</td>
577
552
</tr>
578
553
<tr>
579
 
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
580
 
<td> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a>.
 
554
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
555
<td> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a>.
581
556
</td>
582
557
</tr>
583
558
<tr>
584
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
559
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
585
560
<td> a <a
586
561
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
587
562
><span class="type">gpointer</span></a>.
592
567
</div>
593
568
<hr>
594
569
<div class="refsect2" lang="en">
595
 
<a name="id2862562"></a><h3>
596
 
<a name="g-buffered-input-stream-fill-finish"></a>g_buffered_input_stream_fill_finish ()</h3>
597
 
<a class="indexterm" name="id2862576"></a><pre class="programlisting"><a
 
570
<a name="g-buffered-input-stream-fill-finish"></a><h3>g_buffered_input_stream_fill_finish ()</h3>
 
571
<pre class="programlisting"><a
598
572
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
599
573
>gssize</a>              g_buffered_input_stream_fill_finish (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
600
574
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
604
578
<p>
605
579
Finishes an asynchronous read.</p>
606
580
<p>
607
 
 
608
581
</p>
609
582
<div class="variablelist"><table border="0">
610
583
<col align="left" valign="top">
611
584
<tbody>
612
585
<tr>
613
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
586
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
614
587
<td> a <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
615
588
</td>
616
589
</tr>
617
590
<tr>
618
 
<td><p><span class="term"><em class="parameter"><code>result</code></em>&#160;:</span></p></td>
 
591
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
619
592
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
620
593
</td>
621
594
</tr>
622
595
<tr>
623
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
596
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
624
597
<td> a <a
625
598
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
626
599
><span class="type">GError</span></a>.
627
600
</td>
628
601
</tr>
629
602
<tr>
630
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
603
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
631
604
<td> a <a
632
605
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
633
606
><span class="type">gssize</span></a> of the read stream, or <code class="literal">-1</code> on an error. 
638
611
</div>
639
612
<hr>
640
613
<div class="refsect2" lang="en">
641
 
<a name="id2862716"></a><h3>
642
 
<a name="g-buffered-input-stream-read-byte"></a>g_buffered_input_stream_read_byte ()</h3>
643
 
<a class="indexterm" name="id2862730"></a><pre class="programlisting">int                 g_buffered_input_stream_read_byte   (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
 
614
<a name="g-buffered-input-stream-read-byte"></a><h3>g_buffered_input_stream_read_byte ()</h3>
 
615
<pre class="programlisting">int                 g_buffered_input_stream_read_byte   (<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream,
644
616
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
645
617
                                                         <a
646
618
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
655
627
</p>
656
628
<p>
657
629
If <em class="parameter"><code>cancellable</code></em> is not <a
658
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
630
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
659
631
><code class="literal">NULL</code></a>, then the operation can be cancelled by
660
632
triggering the cancellable object from another thread. If the operation
661
 
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
 
633
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
662
634
operation was partially finished when the operation was cancelled the
663
635
partial result will be returned, without an error.
664
636
</p>
665
637
<p>
666
638
On error -1 is returned and <em class="parameter"><code>error</code></em> is set accordingly.</p>
667
639
<p>
668
 
 
669
640
</p>
670
641
<div class="variablelist"><table border="0">
671
642
<col align="left" valign="top">
672
643
<tbody>
673
644
<tr>
674
 
<td><p><span class="term"><em class="parameter"><code>stream</code></em>&#160;:</span></p></td>
 
645
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
675
646
<td> <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream"><span class="type">GBufferedInputStream</span></a>.
676
647
</td>
677
648
</tr>
678
649
<tr>
679
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
650
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
680
651
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
681
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
652
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
682
653
><code class="literal">NULL</code></a> to ignore.
683
654
</td>
684
655
</tr>
685
656
<tr>
686
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
657
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
687
658
<td> location to store the error occuring, or <a
688
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
659
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
689
660
><code class="literal">NULL</code></a> to ignore.
690
661
</td>
691
662
</tr>
692
663
<tr>
693
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
664
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
694
665
<td> the byte read from the <em class="parameter"><code>stream</code></em>, or -1 on end of stream or error.
695
666
</td>
696
667
</tr>
699
670
</div>
700
671
</div>
701
672
<div class="refsect1" lang="en">
702
 
<a name="id2862928"></a><h2>Property Details</h2>
 
673
<a name="GBufferedInputStream.property-details"></a><h2>Property Details</h2>
703
674
<div class="refsect2" lang="en">
704
 
<a name="id2862939"></a><h3>
705
 
<a name="GBufferedInputStream--buffer-size"></a>The <code class="literal">"buffer-size"</code> property</h3>
706
 
<a class="indexterm" name="id2862955"></a><pre class="programlisting">  "buffer-size"              <a
 
675
<a name="GBufferedInputStream--buffer-size"></a><h3>The <code class="literal">"buffer-size"</code> property</h3>
 
676
<pre class="programlisting">  "buffer-size"              <a
707
677
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
708
678
>guint</a>                 : Read / Write / Construct</pre>
709
679
<p>The size of the backend buffer.</p>
712
682
</div>
713
683
</div>
714
684
<div class="refsect1" lang="en">
715
 
<a name="id2862986"></a><h2>See Also</h2>
716
 
<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>, <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>
717
 
</div>
718
 
<div class="refsect1" lang="en">
719
 
<a name="id2863008"></a><div class="refsect2" lang="en"><a name="id2863009"></a></div>
 
685
<a name="GBufferedInputStream.see-also"></a><h2>See Also</h2>
 
686
#GFilterInputStream, <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>
 
687
</div>
 
688
</div>
 
689
<div class="footer">
720
690
<hr>
721
 
<div class="refsect2" lang="en"><a name="id2863010"></a></div>
722
 
</div>
723
 
</div>
 
691
          Generated by GTK-Doc V1.11</div>
724
692
</body>
725
693
</html>