← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gbufferedoutputstream.xml

  • 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/xml/gbufferedoutputstream.xml
5
5
]>
6
6
<refentry id="GBufferedOutputStream">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GBufferedOutputStream</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GBufferedOutputStream.top_of_page">GBufferedOutputStream</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GBufferedOutputStream</refname>
15
15
<refpurpose>Buffered Output Stream</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GBufferedOutputStream.synopsis" role="synopsis">
20
19
<title role="synopsis.title">Synopsis</title>
21
20
 
22
21
<synopsis>
23
22
 
24
23
#include &lt;gio/gio.h&gt;
25
24
 
26
 
 
27
25
                    <link linkend="GBufferedOutputStream-struct">GBufferedOutputStream</link>;
28
26
<link linkend="GOutputStream">GOutputStream</link>*      <link linkend="g-buffered-output-stream-new">g_buffered_output_stream_new</link>        (<link linkend="GOutputStream">GOutputStream</link> *base_stream);
29
27
<link linkend="GOutputStream">GOutputStream</link>*      <link linkend="g-buffered-output-stream-new-sized">g_buffered_output_stream_new_sized</link>  (<link linkend="GOutputStream">GOutputStream</link> *base_stream,
38
36
<link linkend="void">void</link>                <link linkend="g-buffered-output-stream-set-auto-grow">g_buffered_output_stream_set_auto_grow</link>
39
37
                                                        (<link linkend="GBufferedOutputStream">GBufferedOutputStream</link> *stream,
40
38
                                                         <link linkend="gboolean">gboolean</link> auto_grow);
41
 
 
42
 
 
43
39
</synopsis>
44
40
</refsynopsisdiv>
45
41
 
46
 
<refsect1 role="object_hierarchy">
 
42
<refsect1 id="GBufferedOutputStream.object-hierarchy" role="object_hierarchy">
47
43
<title role="object_hierarchy.title">Object Hierarchy</title>
48
44
<synopsis>
49
 
 
50
45
  <link linkend="GObject">GObject</link>
51
46
   +----<link linkend="GOutputStream">GOutputStream</link>
52
47
         +----<link linkend="GFilterOutputStream">GFilterOutputStream</link>
53
48
               +----GBufferedOutputStream
54
49
</synopsis>
55
 
 
56
50
</refsect1>
57
51
 
58
52
 
59
53
 
60
54
 
61
55
 
62
 
<refsect1 role="properties">
 
56
<refsect1 id="GBufferedOutputStream.properties" role="properties">
63
57
<title role="properties.title">Properties</title>
64
58
<synopsis>
65
 
 
66
59
  &quot;<link linkend="GBufferedOutputStream--auto-grow">auto-grow</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
67
60
  &quot;<link linkend="GBufferedOutputStream--buffer-size">buffer-size</link>&quot;              <link linkend="guint">guint</link>                 : Read / Write / Construct
68
61
</synopsis>
70
63
 
71
64
 
72
65
 
73
 
<refsect1 role="desc">
 
66
<refsect1 id="GBufferedOutputStream.description" role="desc">
74
67
<title role="desc.title">Description</title>
75
68
<para>
76
69
Buffered output stream implements <link linkend="GFilterOutputStream"><type>GFilterOutputStream</type></link> and provides 
91
84
<link linkend="g-buffered-output-stream-set-buffer-size"><function>g_buffered_output_stream_set_buffer_size()</function></link>. Note that the buffer's 
92
85
size cannot be reduced below the size of the data within the buffer.</para>
93
86
<para>
94
 
 
95
87
</para>
96
88
</refsect1>
97
89
 
98
 
<refsect1 role="details">
 
90
<refsect1 id="GBufferedOutputStream.details" role="details">
99
91
<title role="details.title">Details</title>
100
 
<refsect2>
101
 
<title><anchor id="GBufferedOutputStream-struct" role="struct"/>GBufferedOutputStream</title>
102
 
<indexterm><primary>GBufferedOutputStream</primary></indexterm><programlisting>typedef struct _GBufferedOutputStream GBufferedOutputStream;</programlisting>
 
92
<refsect2 id="GBufferedOutputStream-struct" role="struct">
 
93
<title>GBufferedOutputStream</title>
 
94
<indexterm zone="GBufferedOutputStream-struct"><primary sortas="GBufferedOutputStream">GBufferedOutputStream</primary></indexterm><programlisting>typedef struct _GBufferedOutputStream GBufferedOutputStream;</programlisting>
103
95
<para>
104
96
An implementation of <link linkend="GFilterOutputStream"><type>GFilterOutputStream</type></link> with a sized buffer.</para>
105
97
<para>
106
 
 
107
98
</para><variablelist role="struct">
108
99
</variablelist></refsect2>
109
 
<refsect2>
110
 
<title><anchor id="g-buffered-output-stream-new" role="function"/>g_buffered_output_stream_new ()</title>
111
 
<indexterm><primary>g_buffered_output_stream_new</primary></indexterm><programlisting><link linkend="GOutputStream">GOutputStream</link>*      g_buffered_output_stream_new        (<link linkend="GOutputStream">GOutputStream</link> *base_stream);</programlisting>
 
100
<refsect2 id="g-buffered-output-stream-new" role="function">
 
101
<title>g_buffered_output_stream_new ()</title>
 
102
<indexterm zone="g-buffered-output-stream-new"><primary sortas="g_buffered_output_stream_new">g_buffered_output_stream_new</primary></indexterm><programlisting><link linkend="GOutputStream">GOutputStream</link>*      g_buffered_output_stream_new        (<link linkend="GOutputStream">GOutputStream</link> *base_stream);</programlisting>
112
103
<para>
113
104
Creates a new buffered output stream for a base stream.</para>
114
105
<para>
115
 
 
116
106
</para><variablelist role="params">
117
 
<varlistentry><term><parameter>base_stream</parameter>&nbsp;:</term>
 
107
<varlistentry><term><parameter>base_stream</parameter>&#160;:</term>
118
108
<listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link>.
119
109
</simpara></listitem></varlistentry>
120
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link> for the given <parameter>base_stream</parameter>.
 
110
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link> for the given <parameter>base_stream</parameter>.
121
111
</simpara></listitem></varlistentry>
122
112
</variablelist></refsect2>
123
 
<refsect2>
124
 
<title><anchor id="g-buffered-output-stream-new-sized" role="function"/>g_buffered_output_stream_new_sized ()</title>
125
 
<indexterm><primary>g_buffered_output_stream_new_sized</primary></indexterm><programlisting><link linkend="GOutputStream">GOutputStream</link>*      g_buffered_output_stream_new_sized  (<link linkend="GOutputStream">GOutputStream</link> *base_stream,
 
113
<refsect2 id="g-buffered-output-stream-new-sized" role="function">
 
114
<title>g_buffered_output_stream_new_sized ()</title>
 
115
<indexterm zone="g-buffered-output-stream-new-sized"><primary sortas="g_buffered_output_stream_new_sized">g_buffered_output_stream_new_sized</primary></indexterm><programlisting><link linkend="GOutputStream">GOutputStream</link>*      g_buffered_output_stream_new_sized  (<link linkend="GOutputStream">GOutputStream</link> *base_stream,
126
116
                                                         <link linkend="gsize">gsize</link> size);</programlisting>
127
117
<para>
128
118
Creates a new buffered output stream with a given buffer size.</para>
129
119
<para>
130
 
 
131
120
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>base_stream</parameter>&nbsp;:</term>
 
121
<varlistentry><term><parameter>base_stream</parameter>&#160;:</term>
133
122
<listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link>.
134
123
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>size</parameter>&nbsp;:</term>
 
124
<varlistentry><term><parameter>size</parameter>&#160;:</term>
136
125
<listitem><simpara> a <link linkend="gsize"><type>gsize</type></link>.
137
126
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link> with an internal buffer set to <parameter>size</parameter>.
 
127
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link> with an internal buffer set to <parameter>size</parameter>.
139
128
</simpara></listitem></varlistentry>
140
129
</variablelist></refsect2>
141
 
<refsect2>
142
 
<title><anchor id="g-buffered-output-stream-get-buffer-size" role="function"/>g_buffered_output_stream_get_buffer_size ()</title>
143
 
<indexterm><primary>g_buffered_output_stream_get_buffer_size</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               g_buffered_output_stream_get_buffer_size
 
130
<refsect2 id="g-buffered-output-stream-get-buffer-size" role="function">
 
131
<title>g_buffered_output_stream_get_buffer_size ()</title>
 
132
<indexterm zone="g-buffered-output-stream-get-buffer-size"><primary sortas="g_buffered_output_stream_get_buffer_size">g_buffered_output_stream_get_buffer_size</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               g_buffered_output_stream_get_buffer_size
144
133
                                                        (<link linkend="GBufferedOutputStream">GBufferedOutputStream</link> *stream);</programlisting>
145
134
<para>
146
135
Gets the size of the buffer in the <parameter>stream</parameter>.</para>
147
136
<para>
148
 
 
149
137
</para><variablelist role="params">
150
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
138
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
151
139
<listitem><simpara> a <link linkend="GBufferedOutputStream"><type>GBufferedOutputStream</type></link>.
152
140
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current size of the buffer.
 
141
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current size of the buffer.
154
142
</simpara></listitem></varlistentry>
155
143
</variablelist></refsect2>
156
 
<refsect2>
157
 
<title><anchor id="g-buffered-output-stream-set-buffer-size" role="function"/>g_buffered_output_stream_set_buffer_size ()</title>
158
 
<indexterm><primary>g_buffered_output_stream_set_buffer_size</primary></indexterm><programlisting><link linkend="void">void</link>                g_buffered_output_stream_set_buffer_size
 
144
<refsect2 id="g-buffered-output-stream-set-buffer-size" role="function">
 
145
<title>g_buffered_output_stream_set_buffer_size ()</title>
 
146
<indexterm zone="g-buffered-output-stream-set-buffer-size"><primary sortas="g_buffered_output_stream_set_buffer_size">g_buffered_output_stream_set_buffer_size</primary></indexterm><programlisting><link linkend="void">void</link>                g_buffered_output_stream_set_buffer_size
159
147
                                                        (<link linkend="GBufferedOutputStream">GBufferedOutputStream</link> *stream,
160
148
                                                         <link linkend="gsize">gsize</link> size);</programlisting>
161
149
<para>
162
150
Sets the size of the internal buffer to <parameter>size</parameter>.</para>
163
151
<para>
164
 
 
165
152
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
153
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
167
154
<listitem><simpara> a <link linkend="GBufferedOutputStream"><type>GBufferedOutputStream</type></link>.
168
155
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>size</parameter>&nbsp;:</term>
 
156
<varlistentry><term><parameter>size</parameter>&#160;:</term>
170
157
<listitem><simpara> a <link linkend="gsize"><type>gsize</type></link>.
171
158
</simpara></listitem></varlistentry>
172
159
</variablelist></refsect2>
173
 
<refsect2>
174
 
<title><anchor id="g-buffered-output-stream-get-auto-grow" role="function"/>g_buffered_output_stream_get_auto_grow ()</title>
175
 
<indexterm><primary>g_buffered_output_stream_get_auto_grow</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_buffered_output_stream_get_auto_grow
 
160
<refsect2 id="g-buffered-output-stream-get-auto-grow" role="function">
 
161
<title>g_buffered_output_stream_get_auto_grow ()</title>
 
162
<indexterm zone="g-buffered-output-stream-get-auto-grow"><primary sortas="g_buffered_output_stream_get_auto_grow">g_buffered_output_stream_get_auto_grow</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_buffered_output_stream_get_auto_grow
176
163
                                                        (<link linkend="GBufferedOutputStream">GBufferedOutputStream</link> *stream);</programlisting>
177
164
<para>
178
165
Checks if the buffer automatically grows as data is added.</para>
179
166
<para>
180
 
 
181
167
</para><variablelist role="params">
182
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
168
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
183
169
<listitem><simpara> a <link linkend="GBufferedOutputStream"><type>GBufferedOutputStream</type></link>.
184
170
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>stream</parameter>'s buffer automatically grows,
186
 
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
171
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the <parameter>stream</parameter>'s buffer automatically grows,
 
172
<link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
187
173
</simpara></listitem></varlistentry>
188
174
</variablelist></refsect2>
189
 
<refsect2>
190
 
<title><anchor id="g-buffered-output-stream-set-auto-grow" role="function"/>g_buffered_output_stream_set_auto_grow ()</title>
191
 
<indexterm><primary>g_buffered_output_stream_set_auto_grow</primary></indexterm><programlisting><link linkend="void">void</link>                g_buffered_output_stream_set_auto_grow
 
175
<refsect2 id="g-buffered-output-stream-set-auto-grow" role="function">
 
176
<title>g_buffered_output_stream_set_auto_grow ()</title>
 
177
<indexterm zone="g-buffered-output-stream-set-auto-grow"><primary sortas="g_buffered_output_stream_set_auto_grow">g_buffered_output_stream_set_auto_grow</primary></indexterm><programlisting><link linkend="void">void</link>                g_buffered_output_stream_set_auto_grow
192
178
                                                        (<link linkend="GBufferedOutputStream">GBufferedOutputStream</link> *stream,
193
179
                                                         <link linkend="gboolean">gboolean</link> auto_grow);</programlisting>
194
180
<para>
197
183
larger, and you must manually flush the buffer to actually write out
198
184
the data to the underlying stream.</para>
199
185
<para>
200
 
 
201
186
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
187
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
203
188
<listitem><simpara> a <link linkend="GBufferedOutputStream"><type>GBufferedOutputStream</type></link>.
204
189
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>auto_grow</parameter>&nbsp;:</term>
 
190
<varlistentry><term><parameter>auto_grow</parameter>&#160;:</term>
206
191
<listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>.
207
192
</simpara></listitem></varlistentry>
208
193
</variablelist></refsect2>
209
194
 
210
195
</refsect1>
211
 
<refsect1 role="property_details">
 
196
<refsect1 id="GBufferedOutputStream.property-details" role="property_details">
212
197
<title role="property_details.title">Property Details</title>
213
 
<refsect2><title><anchor id="GBufferedOutputStream--auto-grow"/>The <literal>&quot;auto-grow&quot;</literal> property</title>
214
 
<indexterm><primary>GBufferedOutputStream:auto-grow</primary></indexterm><programlisting>  &quot;auto-grow&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
198
<refsect2 id="GBufferedOutputStream--auto-grow" role="property"><title>The <literal>&quot;auto-grow&quot;</literal> property</title>
 
199
<indexterm zone="GBufferedOutputStream--auto-grow"><primary sortas="GBufferedOutputStream:auto-grow">GBufferedOutputStream:auto-grow</primary></indexterm><programlisting>  &quot;auto-grow&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
215
200
<para>Whether the buffer should automatically grow.</para><para>Default value: FALSE</para>
216
201
</refsect2>
217
 
<refsect2><title><anchor id="GBufferedOutputStream--buffer-size"/>The <literal>&quot;buffer-size&quot;</literal> property</title>
218
 
<indexterm><primary>GBufferedOutputStream:buffer-size</primary></indexterm><programlisting>  &quot;buffer-size&quot;              <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
 
202
<refsect2 id="GBufferedOutputStream--buffer-size" role="property"><title>The <literal>&quot;buffer-size&quot;</literal> property</title>
 
203
<indexterm zone="GBufferedOutputStream--buffer-size"><primary sortas="GBufferedOutputStream:buffer-size">GBufferedOutputStream:buffer-size</primary></indexterm><programlisting>  &quot;buffer-size&quot;              <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
219
204
<para>The size of the backend buffer.</para><para>Allowed values: &gt;= 1</para>
220
205
<para>Default value: 4096</para>
221
206
</refsect2>
222
 
 
223
207
</refsect1>
224
208
 
225
209
 
226
210
 
227
 
<refsect1>
 
211
<refsect1 id="GBufferedOutputStream.see-also">
228
212
<title>See Also</title>
229
 
<link linkend="GFilterOutputStream"><type>GFilterOutputStream</type></link>, <link linkend="GOutputStream"><type>GOutputStream</type></link>
 
213
#GFilterOutputStream, <link linkend="GOutputStream"><type>GOutputStream</type></link>
230
214
</refsect1>
231
215
 
232
 
 
233
 
<refsect1><refsect2 /><refsect2 /></refsect1>
234
216
</refentry>