← 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/gfileoutputstream.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/gfileoutputstream.xml
5
5
]>
6
6
<refentry id="GFileOutputStream">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GFileOutputStream</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GFileOutputStream.top_of_page">GFileOutputStream</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GFileOutputStream</refname>
15
15
<refpurpose>File output streaming operations</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GFileOutputStream.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="GFileOutputStream-struct">GFileOutputStream</link>;
28
 
<link linkend="GFileInfo">GFileInfo</link>*          <link linkend="g-file-output-stream-query-info">g_file_output_stream_query_info</link>     (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
 
26
<link linkend="GFileInfo">GFileInfo</link> *         <link linkend="g-file-output-stream-query-info">g_file_output_stream_query_info</link>     (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
29
27
                                                         <link linkend="char">char</link> *attributes,
30
28
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
31
29
                                                         <link linkend="GError">GError</link> **error);
36
34
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
37
35
                                                         <link linkend="GAsyncReadyCallback">GAsyncReadyCallback</link> callback,
38
36
                                                         <link linkend="gpointer">gpointer</link> user_data);
39
 
<link linkend="GFileInfo">GFileInfo</link>*          <link linkend="g-file-output-stream-query-info-finish">g_file_output_stream_query_info_finish</link>
 
37
<link linkend="GFileInfo">GFileInfo</link> *         <link linkend="g-file-output-stream-query-info-finish">g_file_output_stream_query_info_finish</link>
40
38
                                                        (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
41
39
                                                         <link linkend="GAsyncResult">GAsyncResult</link> *result,
42
40
                                                         <link linkend="GError">GError</link> **error);
43
 
<link linkend="char">char</link>*               <link linkend="g-file-output-stream-get-etag">g_file_output_stream_get_etag</link>       (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream);
44
 
 
45
 
 
 
41
<link linkend="char">char</link> *              <link linkend="g-file-output-stream-get-etag">g_file_output_stream_get_etag</link>       (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream);
46
42
</synopsis>
47
43
</refsynopsisdiv>
48
44
 
49
 
<refsect1 role="object_hierarchy">
 
45
<refsect1 id="GFileOutputStream.object-hierarchy" role="object_hierarchy">
50
46
<title role="object_hierarchy.title">Object Hierarchy</title>
51
47
<synopsis>
52
 
 
53
48
  <link linkend="GObject">GObject</link>
54
49
   +----<link linkend="GOutputStream">GOutputStream</link>
55
50
         +----GFileOutputStream
56
51
</synopsis>
57
 
 
58
52
</refsect1>
59
53
 
60
54
 
61
55
 
62
 
<refsect1 role="impl_interfaces">
 
56
<refsect1 id="GFileOutputStream.implemented-interfaces" role="impl_interfaces">
63
57
<title role="impl_interfaces.title">Implemented Interfaces</title>
64
58
<para>
65
59
GFileOutputStream implements
66
60
 <link linkend="GSeekable">GSeekable</link>.</para>
67
 
 
68
61
</refsect1>
69
62
 
70
63
 
71
64
 
72
65
 
73
66
 
74
 
<refsect1 role="desc">
 
67
<refsect1 id="GFileOutputStream.description" role="desc">
75
68
<title role="desc.title">Description</title>
76
69
<para>
77
70
GFileOutputStream provides output streams that write their
91
84
<link linkend="g-file-output-stream-can-truncate"><function>g_file_output_stream_can_truncate()</function></link>. To truncate a file output
92
85
stream, use <link linkend="g-file-output-stream-truncate"><function>g_file_output_stream_truncate()</function></link>.</para>
93
86
<para>
94
 
 
95
87
</para>
96
88
</refsect1>
97
89
 
98
 
<refsect1 role="details">
 
90
<refsect1 id="GFileOutputStream.details" role="details">
99
91
<title role="details.title">Details</title>
100
 
<refsect2>
101
 
<title><anchor id="GFileOutputStream-struct" role="struct"/>GFileOutputStream</title>
102
 
<indexterm><primary>GFileOutputStream</primary></indexterm><programlisting>typedef struct _GFileOutputStream GFileOutputStream;</programlisting>
 
92
<refsect2 id="GFileOutputStream-struct" role="struct">
 
93
<title>GFileOutputStream</title>
 
94
<indexterm zone="GFileOutputStream-struct"><primary sortas="GFileOutputStream">GFileOutputStream</primary></indexterm><programlisting>typedef struct _GFileOutputStream GFileOutputStream;</programlisting>
103
95
<para>
104
96
A subclass of GOutputStream for opened files. This adds
105
97
a few file-specific operations and seeking and truncating.
107
99
<para>
108
100
<link linkend="GFileOutputStream"><type>GFileOutputStream</type></link> implements GSeekable.</para>
109
101
<para>
110
 
 
111
102
</para></refsect2>
112
 
<refsect2>
113
 
<title><anchor id="g-file-output-stream-query-info" role="function"/>g_file_output_stream_query_info ()</title>
114
 
<indexterm><primary>g_file_output_stream_query_info</primary></indexterm><programlisting><link linkend="GFileInfo">GFileInfo</link>*          g_file_output_stream_query_info     (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
 
103
<refsect2 id="g-file-output-stream-query-info" role="function">
 
104
<title>g_file_output_stream_query_info ()</title>
 
105
<indexterm zone="g-file-output-stream-query-info"><primary sortas="g_file_output_stream_query_info">g_file_output_stream_query_info</primary></indexterm><programlisting><link linkend="GFileInfo">GFileInfo</link> *         g_file_output_stream_query_info     (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
115
106
                                                         <link linkend="char">char</link> *attributes,
116
107
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
117
108
                                                         <link linkend="GError">GError</link> **error);</programlisting>
121
112
version of this function, see <link linkend="g-file-output-stream-query-info-async"><function>g_file_output_stream_query_info_async()</function></link>. 
122
113
While the stream is blocked, the stream will set the pending flag 
123
114
internally, and any other operations on the stream will fail with 
124
 
<link linkend="G-IO-ERROR-PENDING:CAPS"><literal>G_IO_ERROR_PENDING</literal></link>.
 
115
<link linkend="G-IO-ERROR-PENDING--CAPS"><literal>G_IO_ERROR_PENDING</literal></link>.
125
116
</para>
126
117
<para>
127
118
Can fail if the stream was already closed (with <parameter>error</parameter> being set to 
128
 
<link linkend="G-IO-ERROR-CLOSED:CAPS"><literal>G_IO_ERROR_CLOSED</literal></link>), the stream has pending operations (with <parameter>error</parameter> being
129
 
set to <link linkend="G-IO-ERROR-PENDING:CAPS"><literal>G_IO_ERROR_PENDING</literal></link>), or if querying info is not supported for 
130
 
the stream's interface (with <parameter>error</parameter> being set to <link linkend="G-IO-ERROR-NOT-SUPPORTED:CAPS"><literal>G_IO_ERROR_NOT_SUPPORTED</literal></link>). In
131
 
all cases of failure, <link linkend="NULL:CAPS"><literal>NULL</literal></link> will be returned.
 
119
<link linkend="G-IO-ERROR-CLOSED--CAPS"><literal>G_IO_ERROR_CLOSED</literal></link>), the stream has pending operations (with <parameter>error</parameter> being
 
120
set to <link linkend="G-IO-ERROR-PENDING--CAPS"><literal>G_IO_ERROR_PENDING</literal></link>), or if querying info is not supported for 
 
121
the stream's interface (with <parameter>error</parameter> being set to <link linkend="G-IO-ERROR-NOT-SUPPORTED--CAPS"><literal>G_IO_ERROR_NOT_SUPPORTED</literal></link>). In
 
122
all cases of failure, <link linkend="NULL--CAPS"><literal>NULL</literal></link> will be returned.
132
123
</para>
133
124
<para>
134
 
If <parameter>cancellable</parameter> is not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, then the operation can be cancelled by
 
125
If <parameter>cancellable</parameter> is not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, then the operation can be cancelled by
135
126
triggering the cancellable object from another thread. If the operation
136
 
was cancelled, the error <link linkend="G-IO-ERROR-CANCELLED:CAPS"><literal>G_IO_ERROR_CANCELLED</literal></link> will be set, and <link linkend="NULL:CAPS"><literal>NULL</literal></link> will 
 
127
was cancelled, the error <link linkend="G-IO-ERROR-CANCELLED--CAPS"><literal>G_IO_ERROR_CANCELLED</literal></link> will be set, and <link linkend="NULL--CAPS"><literal>NULL</literal></link> will 
137
128
be returned.</para>
138
129
<para>
139
 
 
140
130
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
131
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
142
132
<listitem><simpara> a <link linkend="GFileOutputStream"><type>GFileOutputStream</type></link>.
143
133
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>attributes</parameter>&nbsp;:</term>
 
134
<varlistentry><term><parameter>attributes</parameter>&#160;:</term>
145
135
<listitem><simpara> a file attribute query string.
146
136
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
148
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore. 
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
151
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GFileInfo"><type>GFileInfo</type></link> for the <parameter>stream</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.
 
137
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
138
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore. 
 
139
</simpara></listitem></varlistentry>
 
140
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
141
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
142
</simpara></listitem></varlistentry>
 
143
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GFileInfo"><type>GFileInfo</type></link> for the <parameter>stream</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on error.
154
144
</simpara></listitem></varlistentry>
155
145
</variablelist></refsect2>
156
 
<refsect2>
157
 
<title><anchor id="g-file-output-stream-query-info-async" role="function"/>g_file_output_stream_query_info_async ()</title>
158
 
<indexterm><primary>g_file_output_stream_query_info_async</primary></indexterm><programlisting><link linkend="void">void</link>                g_file_output_stream_query_info_async
 
146
<refsect2 id="g-file-output-stream-query-info-async" role="function">
 
147
<title>g_file_output_stream_query_info_async ()</title>
 
148
<indexterm zone="g-file-output-stream-query-info-async"><primary sortas="g_file_output_stream_query_info_async">g_file_output_stream_query_info_async</primary></indexterm><programlisting><link linkend="void">void</link>                g_file_output_stream_query_info_async
159
149
                                                        (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
160
150
                                                         <link linkend="char">char</link> *attributes,
161
151
                                                         <link linkend="int">int</link> io_priority,
171
161
For the synchronous version of this function, see 
172
162
<link linkend="g-file-output-stream-query-info"><function>g_file_output_stream_query_info()</function></link>.</para>
173
163
<para>
174
 
 
175
164
</para><variablelist role="params">
176
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
165
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
177
166
<listitem><simpara> a <link linkend="GFileOutputStream"><type>GFileOutputStream</type></link>.
178
167
</simpara></listitem></varlistentry>
179
 
<varlistentry><term><parameter>attributes</parameter>&nbsp;:</term>
 
168
<varlistentry><term><parameter>attributes</parameter>&#160;:</term>
180
169
<listitem><simpara> a file attribute query string.
181
170
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>io_priority</parameter>&nbsp;:</term>
 
171
<varlistentry><term><parameter>io_priority</parameter>&#160;:</term>
183
172
<listitem><simpara> the <link linkend="gio-GIOScheduler">I/O priority</link> 
184
173
    of the request.
185
174
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
187
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore. 
 
175
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
176
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore. 
188
177
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
178
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
190
179
<listitem><simpara> callback to call when the request is satisfied
191
180
</simpara></listitem></varlistentry>
192
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
181
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
193
182
<listitem><simpara> the data to pass to callback function
194
183
</simpara></listitem></varlistentry>
195
184
</variablelist></refsect2>
196
 
<refsect2>
197
 
<title><anchor id="g-file-output-stream-query-info-finish" role="function"/>g_file_output_stream_query_info_finish ()</title>
198
 
<indexterm><primary>g_file_output_stream_query_info_finish</primary></indexterm><programlisting><link linkend="GFileInfo">GFileInfo</link>*          g_file_output_stream_query_info_finish
 
185
<refsect2 id="g-file-output-stream-query-info-finish" role="function">
 
186
<title>g_file_output_stream_query_info_finish ()</title>
 
187
<indexterm zone="g-file-output-stream-query-info-finish"><primary sortas="g_file_output_stream_query_info_finish">g_file_output_stream_query_info_finish</primary></indexterm><programlisting><link linkend="GFileInfo">GFileInfo</link> *         g_file_output_stream_query_info_finish
199
188
                                                        (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream,
200
189
                                                         <link linkend="GAsyncResult">GAsyncResult</link> *result,
201
190
                                                         <link linkend="GError">GError</link> **error);</programlisting>
203
192
Finalizes the asynchronous query started 
204
193
by <link linkend="g-file-output-stream-query-info-async"><function>g_file_output_stream_query_info_async()</function></link>.</para>
205
194
<para>
206
 
 
207
195
</para><variablelist role="params">
208
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
196
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
209
197
<listitem><simpara> a <link linkend="GFileOutputStream"><type>GFileOutputStream</type></link>.
210
198
</simpara></listitem></varlistentry>
211
 
<varlistentry><term><parameter>result</parameter>&nbsp;:</term>
 
199
<varlistentry><term><parameter>result</parameter>&#160;:</term>
212
200
<listitem><simpara> a <link linkend="GAsyncResult"><type>GAsyncResult</type></link>.
213
201
</simpara></listitem></varlistentry>
214
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
215
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
 
202
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
203
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
216
204
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GFileInfo"><type>GFileInfo</type></link> for the finished query.
 
205
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GFileInfo"><type>GFileInfo</type></link> for the finished query.
218
206
</simpara></listitem></varlistentry>
219
207
</variablelist></refsect2>
220
 
<refsect2>
221
 
<title><anchor id="g-file-output-stream-get-etag" role="function"/>g_file_output_stream_get_etag ()</title>
222
 
<indexterm><primary>g_file_output_stream_get_etag</primary></indexterm><programlisting><link linkend="char">char</link>*               g_file_output_stream_get_etag       (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream);</programlisting>
 
208
<refsect2 id="g-file-output-stream-get-etag" role="function">
 
209
<title>g_file_output_stream_get_etag ()</title>
 
210
<indexterm zone="g-file-output-stream-get-etag"><primary sortas="g_file_output_stream_get_etag">g_file_output_stream_get_etag</primary></indexterm><programlisting><link linkend="char">char</link> *              g_file_output_stream_get_etag       (<link linkend="GFileOutputStream">GFileOutputStream</link> *stream);</programlisting>
223
211
<para>
224
212
Gets the entity tag for the file when it has been written.
225
213
This must be called after the stream has been written
226
214
and closed, as the etag can change while writing.</para>
227
215
<para>
228
 
 
229
216
</para><variablelist role="params">
230
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
217
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
231
218
<listitem><simpara> a <link linkend="GFileOutputStream"><type>GFileOutputStream</type></link>.
232
219
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the entity tag for the stream.
 
220
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the entity tag for the stream.
234
221
</simpara></listitem></varlistentry>
235
222
</variablelist></refsect2>
236
223
 
238
225
 
239
226
 
240
227
 
241
 
<refsect1>
 
228
<refsect1 id="GFileOutputStream.see-also">
242
229
<title>See Also</title>
243
 
<link linkend="GOutputStream"><type>GOutputStream</type></link>, <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>, <link linkend="GSeekable"><type>GSeekable</type></link>
 
230
#GOutputStream, <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>, <link linkend="GSeekable"><type>GSeekable</type></link>
244
231
</refsect1>
245
232
 
246
 
 
247
 
<refsect1><refsect2 /><refsect2 /></refsect1>
248
233
</refentry>