← 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/gdataoutputstream.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/gdataoutputstream.xml
5
5
]>
6
6
<refentry id="GDataOutputStream">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GDataOutputStream</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GDataOutputStream.top_of_page">GDataOutputStream</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GDataOutputStream</refname>
15
15
<refpurpose>Data Output Stream</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GDataOutputStream.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="GDataOutputStream-struct">GDataOutputStream</link>;
28
 
<link linkend="GDataOutputStream">GDataOutputStream</link>*  <link linkend="g-data-output-stream-new">g_data_output_stream_new</link>            (<link linkend="GOutputStream">GOutputStream</link> *base_stream);
 
26
<link linkend="GDataOutputStream">GDataOutputStream</link> * <link linkend="g-data-output-stream-new">g_data_output_stream_new</link>            (<link linkend="GOutputStream">GOutputStream</link> *base_stream);
29
27
<link linkend="void">void</link>                <link linkend="g-data-output-stream-set-byte-order">g_data_output_stream_set_byte_order</link> (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
30
28
                                                         <link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link> order);
31
 
<link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link> <link linkend="g-data-output-stream-get-byte-order">g_data_output_stream_get_byte_order</link>
 
29
<link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link>  <link linkend="g-data-output-stream-get-byte-order">g_data_output_stream_get_byte_order</link>
32
30
                                                        (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream);
33
31
<link linkend="gboolean">gboolean</link>            <link linkend="g-data-output-stream-put-byte">g_data_output_stream_put_byte</link>       (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
34
32
                                                         <link linkend="guchar">guchar</link> data,
62
60
                                                         const <link linkend="char">char</link> *str,
63
61
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
64
62
                                                         <link linkend="GError">GError</link> **error);
65
 
 
66
 
 
67
63
</synopsis>
68
64
</refsynopsisdiv>
69
65
 
70
 
<refsect1 role="object_hierarchy">
 
66
<refsect1 id="GDataOutputStream.object-hierarchy" role="object_hierarchy">
71
67
<title role="object_hierarchy.title">Object Hierarchy</title>
72
68
<synopsis>
73
 
 
74
69
  <link linkend="GObject">GObject</link>
75
70
   +----<link linkend="GOutputStream">GOutputStream</link>
76
71
         +----<link linkend="GFilterOutputStream">GFilterOutputStream</link>
77
72
               +----GDataOutputStream
78
73
</synopsis>
79
 
 
80
74
</refsect1>
81
75
 
82
76
 
83
77
 
84
78
 
85
79
 
86
 
<refsect1 role="properties">
 
80
<refsect1 id="GDataOutputStream.properties" role="properties">
87
81
<title role="properties.title">Properties</title>
88
82
<synopsis>
89
 
 
90
83
  &quot;<link linkend="GDataOutputStream--byte-order">byte-order</link>&quot;               <link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link>  : Read / Write
91
84
</synopsis>
92
85
</refsect1>
93
86
 
94
87
 
95
88
 
96
 
<refsect1 role="desc">
 
89
<refsect1 id="GDataOutputStream.description" role="desc">
97
90
<title role="desc.title">Description</title>
98
91
<para>
99
92
Data output stream implements <link linkend="GOutputStream"><type>GOutputStream</type></link> and includes functions for 
100
93
writing data directly to an output stream.</para>
101
94
<para>
102
 
 
103
95
</para>
104
96
</refsect1>
105
97
 
106
 
<refsect1 role="details">
 
98
<refsect1 id="GDataOutputStream.details" role="details">
107
99
<title role="details.title">Details</title>
108
 
<refsect2>
109
 
<title><anchor id="GDataOutputStream-struct" role="struct"/>GDataOutputStream</title>
110
 
<indexterm><primary>GDataOutputStream</primary></indexterm><programlisting>typedef struct _GDataOutputStream GDataOutputStream;</programlisting>
 
100
<refsect2 id="GDataOutputStream-struct" role="struct">
 
101
<title>GDataOutputStream</title>
 
102
<indexterm zone="GDataOutputStream-struct"><primary sortas="GDataOutputStream">GDataOutputStream</primary></indexterm><programlisting>typedef struct _GDataOutputStream GDataOutputStream;</programlisting>
111
103
<para>
112
 
An implementation of <link linkend="GBufferedOutputStream"><type>GBufferedOutputStream</type></link> that allows for high-level 
 
104
An implementation of <link linkend="GBufferedOutputStream"><type>GBufferedOutputStream</type></link> that allows for high-level
113
105
data manipulation of arbitrary data (including binary operations).</para>
114
106
<para>
115
 
 
116
107
</para><variablelist role="struct">
117
108
</variablelist></refsect2>
118
 
<refsect2>
119
 
<title><anchor id="g-data-output-stream-new" role="function"/>g_data_output_stream_new ()</title>
120
 
<indexterm><primary>g_data_output_stream_new</primary></indexterm><programlisting><link linkend="GDataOutputStream">GDataOutputStream</link>*  g_data_output_stream_new            (<link linkend="GOutputStream">GOutputStream</link> *base_stream);</programlisting>
 
109
<refsect2 id="g-data-output-stream-new" role="function">
 
110
<title>g_data_output_stream_new ()</title>
 
111
<indexterm zone="g-data-output-stream-new"><primary sortas="g_data_output_stream_new">g_data_output_stream_new</primary></indexterm><programlisting><link linkend="GDataOutputStream">GDataOutputStream</link> * g_data_output_stream_new            (<link linkend="GOutputStream">GOutputStream</link> *base_stream);</programlisting>
121
112
<para>
122
113
Creates a new data output stream for <parameter>base_stream</parameter>.</para>
123
114
<para>
124
 
 
125
115
</para><variablelist role="params">
126
 
<varlistentry><term><parameter>base_stream</parameter>&nbsp;:</term>
 
116
<varlistentry><term><parameter>base_stream</parameter>&#160;:</term>
127
117
<listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link>.
128
118
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
 
119
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
130
120
</simpara></listitem></varlistentry>
131
121
</variablelist></refsect2>
132
 
<refsect2>
133
 
<title><anchor id="g-data-output-stream-set-byte-order" role="function"/>g_data_output_stream_set_byte_order ()</title>
134
 
<indexterm><primary>g_data_output_stream_set_byte_order</primary></indexterm><programlisting><link linkend="void">void</link>                g_data_output_stream_set_byte_order (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
122
<refsect2 id="g-data-output-stream-set-byte-order" role="function">
 
123
<title>g_data_output_stream_set_byte_order ()</title>
 
124
<indexterm zone="g-data-output-stream-set-byte-order"><primary sortas="g_data_output_stream_set_byte_order">g_data_output_stream_set_byte_order</primary></indexterm><programlisting><link linkend="void">void</link>                g_data_output_stream_set_byte_order (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
135
125
                                                         <link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link> order);</programlisting>
136
126
<para>
137
127
Sets the byte order of the data output stream to <parameter>order</parameter>.</para>
138
128
<para>
139
 
 
140
129
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
130
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
142
131
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
143
132
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>order</parameter>&nbsp;:</term>
 
133
<varlistentry><term><parameter>order</parameter>&#160;:</term>
145
134
<listitem><simpara> a <link linkend="GDataStreamByteOrder"><literal>GDataStreamByteOrder</literal></link>.
146
135
</simpara></listitem></varlistentry>
147
136
</variablelist></refsect2>
148
 
<refsect2>
149
 
<title><anchor id="g-data-output-stream-get-byte-order" role="function"/>g_data_output_stream_get_byte_order ()</title>
150
 
<indexterm><primary>g_data_output_stream_get_byte_order</primary></indexterm><programlisting><link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link> g_data_output_stream_get_byte_order
 
137
<refsect2 id="g-data-output-stream-get-byte-order" role="function">
 
138
<title>g_data_output_stream_get_byte_order ()</title>
 
139
<indexterm zone="g-data-output-stream-get-byte-order"><primary sortas="g_data_output_stream_get_byte_order">g_data_output_stream_get_byte_order</primary></indexterm><programlisting><link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link>  g_data_output_stream_get_byte_order
151
140
                                                        (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream);</programlisting>
152
141
<para>
153
142
Gets the byte order for the stream.</para>
154
143
<para>
155
 
 
156
144
</para><variablelist role="params">
157
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
145
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
158
146
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
159
147
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GDataStreamByteOrder"><type>GDataStreamByteOrder</type></link> for the <parameter>stream</parameter>.
 
148
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GDataStreamByteOrder"><type>GDataStreamByteOrder</type></link> for the <parameter>stream</parameter>.
161
149
</simpara></listitem></varlistentry>
162
150
</variablelist></refsect2>
163
 
<refsect2>
164
 
<title><anchor id="g-data-output-stream-put-byte" role="function"/>g_data_output_stream_put_byte ()</title>
165
 
<indexterm><primary>g_data_output_stream_put_byte</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_byte       (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
151
<refsect2 id="g-data-output-stream-put-byte" role="function">
 
152
<title>g_data_output_stream_put_byte ()</title>
 
153
<indexterm zone="g-data-output-stream-put-byte"><primary sortas="g_data_output_stream_put_byte">g_data_output_stream_put_byte</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_byte       (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
166
154
                                                         <link linkend="guchar">guchar</link> data,
167
155
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
168
156
                                                         <link linkend="GError">GError</link> **error);</programlisting>
169
157
<para>
170
158
Puts a byte into the output stream.</para>
171
159
<para>
172
 
 
173
160
</para><variablelist role="params">
174
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
161
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
175
162
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
176
163
</simpara></listitem></varlistentry>
177
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
164
<varlistentry><term><parameter>data</parameter>&#160;:</term>
178
165
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link>.
179
166
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
181
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
184
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
185
 
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
167
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
168
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
171
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
172
</simpara></listitem></varlistentry>
 
173
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
187
174
</simpara></listitem></varlistentry>
188
175
</variablelist></refsect2>
189
 
<refsect2>
190
 
<title><anchor id="g-data-output-stream-put-int16" role="function"/>g_data_output_stream_put_int16 ()</title>
191
 
<indexterm><primary>g_data_output_stream_put_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_int16      (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
176
<refsect2 id="g-data-output-stream-put-int16" role="function">
 
177
<title>g_data_output_stream_put_int16 ()</title>
 
178
<indexterm zone="g-data-output-stream-put-int16"><primary sortas="g_data_output_stream_put_int16">g_data_output_stream_put_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_int16      (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
192
179
                                                         <link linkend="gint16">gint16</link> data,
193
180
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
194
181
                                                         <link linkend="GError">GError</link> **error);</programlisting>
195
182
<para>
196
183
Puts a signed 16-bit integer into the output stream.</para>
197
184
<para>
198
 
 
199
185
</para><variablelist role="params">
200
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
186
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
201
187
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
202
188
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
189
<varlistentry><term><parameter>data</parameter>&#160;:</term>
204
190
<listitem><simpara> a <link linkend="gint16"><type>gint16</type></link>.
205
191
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
207
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
208
 
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
210
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
192
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
193
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
194
</simpara></listitem></varlistentry>
 
195
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
196
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
197
</simpara></listitem></varlistentry>
 
198
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
213
199
</simpara></listitem></varlistentry>
214
200
</variablelist></refsect2>
215
 
<refsect2>
216
 
<title><anchor id="g-data-output-stream-put-uint16" role="function"/>g_data_output_stream_put_uint16 ()</title>
217
 
<indexterm><primary>g_data_output_stream_put_uint16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_uint16     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
201
<refsect2 id="g-data-output-stream-put-uint16" role="function">
 
202
<title>g_data_output_stream_put_uint16 ()</title>
 
203
<indexterm zone="g-data-output-stream-put-uint16"><primary sortas="g_data_output_stream_put_uint16">g_data_output_stream_put_uint16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_uint16     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
218
204
                                                         <link linkend="guint16">guint16</link> data,
219
205
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
220
206
                                                         <link linkend="GError">GError</link> **error);</programlisting>
221
207
<para>
222
208
Puts an unsigned 16-bit integer into the output stream.</para>
223
209
<para>
224
 
 
225
210
</para><variablelist role="params">
226
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
211
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
227
212
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
228
213
</simpara></listitem></varlistentry>
229
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
214
<varlistentry><term><parameter>data</parameter>&#160;:</term>
230
215
<listitem><simpara> a <link linkend="guint16"><type>guint16</type></link>.
231
216
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
233
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
236
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
237
 
</simpara></listitem></varlistentry>
238
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
217
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
218
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
219
</simpara></listitem></varlistentry>
 
220
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
221
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
222
</simpara></listitem></varlistentry>
 
223
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
239
224
</simpara></listitem></varlistentry>
240
225
</variablelist></refsect2>
241
 
<refsect2>
242
 
<title><anchor id="g-data-output-stream-put-int32" role="function"/>g_data_output_stream_put_int32 ()</title>
243
 
<indexterm><primary>g_data_output_stream_put_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_int32      (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
226
<refsect2 id="g-data-output-stream-put-int32" role="function">
 
227
<title>g_data_output_stream_put_int32 ()</title>
 
228
<indexterm zone="g-data-output-stream-put-int32"><primary sortas="g_data_output_stream_put_int32">g_data_output_stream_put_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_int32      (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
244
229
                                                         <link linkend="gint32">gint32</link> data,
245
230
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
246
231
                                                         <link linkend="GError">GError</link> **error);</programlisting>
247
232
<para>
248
233
Puts a signed 32-bit integer into the output stream.</para>
249
234
<para>
250
 
 
251
235
</para><variablelist role="params">
252
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
236
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
253
237
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
254
238
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
239
<varlistentry><term><parameter>data</parameter>&#160;:</term>
256
240
<listitem><simpara> a <link linkend="gint32"><type>gint32</type></link>.
257
241
</simpara></listitem></varlistentry>
258
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
259
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
260
 
</simpara></listitem></varlistentry>
261
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
262
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
263
 
</simpara></listitem></varlistentry>
264
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
242
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
243
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
244
</simpara></listitem></varlistentry>
 
245
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
246
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
247
</simpara></listitem></varlistentry>
 
248
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
265
249
</simpara></listitem></varlistentry>
266
250
</variablelist></refsect2>
267
 
<refsect2>
268
 
<title><anchor id="g-data-output-stream-put-uint32" role="function"/>g_data_output_stream_put_uint32 ()</title>
269
 
<indexterm><primary>g_data_output_stream_put_uint32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_uint32     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
251
<refsect2 id="g-data-output-stream-put-uint32" role="function">
 
252
<title>g_data_output_stream_put_uint32 ()</title>
 
253
<indexterm zone="g-data-output-stream-put-uint32"><primary sortas="g_data_output_stream_put_uint32">g_data_output_stream_put_uint32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_uint32     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
270
254
                                                         <link linkend="guint32">guint32</link> data,
271
255
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
272
256
                                                         <link linkend="GError">GError</link> **error);</programlisting>
273
257
<para>
274
258
Puts an unsigned 32-bit integer into the stream.</para>
275
259
<para>
276
 
 
277
260
</para><variablelist role="params">
278
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
261
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
279
262
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
280
263
</simpara></listitem></varlistentry>
281
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
264
<varlistentry><term><parameter>data</parameter>&#160;:</term>
282
265
<listitem><simpara> a <link linkend="guint32"><type>guint32</type></link>.
283
266
</simpara></listitem></varlistentry>
284
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
285
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
286
 
</simpara></listitem></varlistentry>
287
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
288
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
289
 
</simpara></listitem></varlistentry>
290
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
267
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
268
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
269
</simpara></listitem></varlistentry>
 
270
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
271
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
272
</simpara></listitem></varlistentry>
 
273
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
291
274
</simpara></listitem></varlistentry>
292
275
</variablelist></refsect2>
293
 
<refsect2>
294
 
<title><anchor id="g-data-output-stream-put-int64" role="function"/>g_data_output_stream_put_int64 ()</title>
295
 
<indexterm><primary>g_data_output_stream_put_int64</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_int64      (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
276
<refsect2 id="g-data-output-stream-put-int64" role="function">
 
277
<title>g_data_output_stream_put_int64 ()</title>
 
278
<indexterm zone="g-data-output-stream-put-int64"><primary sortas="g_data_output_stream_put_int64">g_data_output_stream_put_int64</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_int64      (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
296
279
                                                         <link linkend="gint64">gint64</link> data,
297
280
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
298
281
                                                         <link linkend="GError">GError</link> **error);</programlisting>
299
282
<para>
300
283
Puts a signed 64-bit integer into the stream.</para>
301
284
<para>
302
 
 
303
285
</para><variablelist role="params">
304
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
286
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
305
287
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
306
288
</simpara></listitem></varlistentry>
307
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
289
<varlistentry><term><parameter>data</parameter>&#160;:</term>
308
290
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link>.
309
291
</simpara></listitem></varlistentry>
310
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
311
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
312
 
</simpara></listitem></varlistentry>
313
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
314
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
315
 
</simpara></listitem></varlistentry>
316
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
292
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
293
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
294
</simpara></listitem></varlistentry>
 
295
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
296
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
297
</simpara></listitem></varlistentry>
 
298
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
317
299
</simpara></listitem></varlistentry>
318
300
</variablelist></refsect2>
319
 
<refsect2>
320
 
<title><anchor id="g-data-output-stream-put-uint64" role="function"/>g_data_output_stream_put_uint64 ()</title>
321
 
<indexterm><primary>g_data_output_stream_put_uint64</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_uint64     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
301
<refsect2 id="g-data-output-stream-put-uint64" role="function">
 
302
<title>g_data_output_stream_put_uint64 ()</title>
 
303
<indexterm zone="g-data-output-stream-put-uint64"><primary sortas="g_data_output_stream_put_uint64">g_data_output_stream_put_uint64</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_uint64     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
322
304
                                                         <link linkend="guint64">guint64</link> data,
323
305
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
324
306
                                                         <link linkend="GError">GError</link> **error);</programlisting>
325
307
<para>
326
308
Puts an unsigned 64-bit integer into the stream.</para>
327
309
<para>
328
 
 
329
310
</para><variablelist role="params">
330
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
311
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
331
312
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
332
313
</simpara></listitem></varlistentry>
333
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
314
<varlistentry><term><parameter>data</parameter>&#160;:</term>
334
315
<listitem><simpara> a <link linkend="guint64"><type>guint64</type></link>.
335
316
</simpara></listitem></varlistentry>
336
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
337
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
338
 
</simpara></listitem></varlistentry>
339
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
340
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
341
 
</simpara></listitem></varlistentry>
342
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
 
317
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
318
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
319
</simpara></listitem></varlistentry>
 
320
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
321
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
322
</simpara></listitem></varlistentry>
 
323
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>data</parameter> was successfully added to the <parameter>stream</parameter>.
343
324
</simpara></listitem></varlistentry>
344
325
</variablelist></refsect2>
345
 
<refsect2>
346
 
<title><anchor id="g-data-output-stream-put-string" role="function"/>g_data_output_stream_put_string ()</title>
347
 
<indexterm><primary>g_data_output_stream_put_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_string     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
 
326
<refsect2 id="g-data-output-stream-put-string" role="function">
 
327
<title>g_data_output_stream_put_string ()</title>
 
328
<indexterm zone="g-data-output-stream-put-string"><primary sortas="g_data_output_stream_put_string">g_data_output_stream_put_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_data_output_stream_put_string     (<link linkend="GDataOutputStream">GDataOutputStream</link> *stream,
348
329
                                                         const <link linkend="char">char</link> *str,
349
330
                                                         <link linkend="GCancellable">GCancellable</link> *cancellable,
350
331
                                                         <link linkend="GError">GError</link> **error);</programlisting>
351
332
<para>
352
333
Puts a string into the output stream.</para>
353
334
<para>
354
 
 
355
335
</para><variablelist role="params">
356
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
336
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
357
337
<listitem><simpara> a <link linkend="GDataOutputStream"><type>GDataOutputStream</type></link>.
358
338
</simpara></listitem></varlistentry>
359
 
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
 
339
<varlistentry><term><parameter>str</parameter>&#160;:</term>
360
340
<listitem><simpara> a string.
361
341
</simpara></listitem></varlistentry>
362
 
<varlistentry><term><parameter>cancellable</parameter>&nbsp;:</term>
363
 
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
364
 
</simpara></listitem></varlistentry>
365
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
366
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore.
367
 
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>string</parameter> was successfully added to the <parameter>stream</parameter>.
 
342
<varlistentry><term><parameter>cancellable</parameter>&#160;:</term>
 
343
<listitem><simpara> optional <link linkend="GCancellable"><type>GCancellable</type></link> object, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
344
</simpara></listitem></varlistentry>
 
345
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
346
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>, <link linkend="NULL--CAPS"><literal>NULL</literal></link> to ignore.
 
347
</simpara></listitem></varlistentry>
 
348
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>string</parameter> was successfully added to the <parameter>stream</parameter>.
369
349
</simpara></listitem></varlistentry>
370
350
</variablelist></refsect2>
371
351
 
372
352
</refsect1>
373
 
<refsect1 role="property_details">
 
353
<refsect1 id="GDataOutputStream.property-details" role="property_details">
374
354
<title role="property_details.title">Property Details</title>
375
 
<refsect2><title><anchor id="GDataOutputStream--byte-order"/>The <literal>&quot;byte-order&quot;</literal> property</title>
376
 
<indexterm><primary>GDataOutputStream:byte-order</primary></indexterm><programlisting>  &quot;byte-order&quot;               <link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link>  : Read / Write</programlisting>
 
355
<refsect2 id="GDataOutputStream--byte-order" role="property"><title>The <literal>&quot;byte-order&quot;</literal> property</title>
 
356
<indexterm zone="GDataOutputStream--byte-order"><primary sortas="GDataOutputStream:byte-order">GDataOutputStream:byte-order</primary></indexterm><programlisting>  &quot;byte-order&quot;               <link linkend="GDataStreamByteOrder">GDataStreamByteOrder</link>  : Read / Write</programlisting>
377
357
<para>
378
 
Determines the byte ordering that is used when writing 
 
358
Determines the byte ordering that is used when writing
379
359
multi-byte entities (such as integers) to the stream.</para>
380
360
<para>
381
 
 
382
361
</para><para>Default value: G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN</para>
383
362
</refsect2>
384
363
 
386
365
 
387
366
 
388
367
 
389
 
<refsect1>
 
368
<refsect1 id="GDataOutputStream.see-also">
390
369
<title>See Also</title>
391
 
<link linkend="GOutputStream"><type>GOutputStream</type></link>
 
370
#GOutputStream
392
371
</refsect1>
393
372
 
394
 
 
395
 
<refsect1><refsect2 /><refsect2 /></refsect1>
396
373
</refentry>