← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/glib/xml/arrays_byte.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/glib/xml/arrays_byte.xml
1
1
<refentry id="glib-Byte-Arrays">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">Byte Arrays</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="glib-Byte-Arrays.top_of_page">Byte Arrays</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GLIB Library</refmiscinfo>
6
6
</refmeta>
8
8
<refnamediv>
9
9
<refname>Byte Arrays</refname>
10
10
<refpurpose>arrays of bytes, which grow automatically as elements are added</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
 
<refsynopsisdiv role="synopsis">
 
13
<refsynopsisdiv id="glib-Byte-Arrays.synopsis" role="synopsis">
15
14
<title role="synopsis.title">Synopsis</title>
16
15
 
17
16
<synopsis>
18
17
 
19
18
#include &lt;glib.h&gt;
20
19
 
21
 
 
22
20
                    <link linkend="GByteArray">GByteArray</link>;
23
21
<link linkend="GByteArray">GByteArray</link>*         <link linkend="g-byte-array-new">g_byte_array_new</link>                    (void);
24
22
<link linkend="GByteArray">GByteArray</link>*         <link linkend="g-byte-array-sized-new">g_byte_array_sized_new</link>              (<link linkend="guint">guint</link> reserved_size);
55
53
 
56
54
 
57
55
 
58
 
<refsect1 role="desc">
 
56
<refsect1 id="glib-Byte-Arrays.description" role="desc">
59
57
<title role="desc.title">Description</title>
60
58
<para>
61
59
<link linkend="GByteArray"><type>GByteArray</type></link> is based on <link linkend="GArray"><type>GArray</type></link>, to provide arrays of bytes which grow
74
72
<para>
75
73
To free a <link linkend="GByteArray"><type>GByteArray</type></link>, use <link linkend="g-byte-array-free"><function>g_byte_array_free()</function></link>.
76
74
</para>
77
 
 
78
75
<example>
79
76
<title>Using a <structname>GByteArray</structname></title>
80
77
<programlisting>
81
78
  GByteArray *gbarray;
82
79
  gint i;
83
 
 
84
80
  gbarray = g_byte_array_new (<!-- -->);
85
81
  for (i = 0; i &lt; 10000; i++)
86
82
    g_byte_array_append (gbarray, (guint8*) "abcd", 4);
87
 
 
88
83
  for (i = 0; i &lt; 10000; i++)
89
84
    {
90
85
      g_assert (gbarray->data[4*i] == 'a');
92
87
      g_assert (gbarray->data[4*i+2] == 'c');
93
88
      g_assert (gbarray->data[4*i+3] == 'd');
94
89
    }
95
 
 
96
90
  g_byte_array_free (gbarray, TRUE);
97
91
</programlisting></example>
98
92
</refsect1>
99
93
 
100
 
<refsect1 role="details">
 
94
<refsect1 id="glib-Byte-Arrays.details" role="details">
101
95
<title role="details.title">Details</title>
102
 
<refsect2>
103
 
<title><anchor id="GByteArray" role="struct"/>GByteArray</title>
104
 
<indexterm><primary>GByteArray</primary></indexterm><programlisting>typedef struct {
 
96
<refsect2 id="GByteArray" role="struct">
 
97
<title>GByteArray</title>
 
98
<indexterm zone="GByteArray"><primary sortas="GByteArray">GByteArray</primary></indexterm><programlisting>typedef struct {
105
99
  guint8 *data;
106
100
  guint   len;
107
101
} GByteArray;
110
104
The <structname>GByteArray</structname> struct allows access to the public fields of a <structname>GByteArray</structname>.
111
105
</para><variablelist role="struct">
112
106
<varlistentry>
113
 
<term><link linkend="guint8">guint8</link>&nbsp;*<structfield>data</structfield>;</term>
 
107
<term><link linkend="guint8">guint8</link>&#160;*<structfield>data</structfield>;</term>
114
108
<listitem><simpara>a pointer to the element data. The data may be moved as elements are
115
109
added to the <link linkend="GByteArray"><type>GByteArray</type></link>.
116
110
</simpara></listitem>
117
111
</varlistentry>
118
112
<varlistentry>
119
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>len</structfield>;</term>
 
113
<term><link linkend="guint">guint</link>&#160;<structfield>len</structfield>;</term>
120
114
<listitem><simpara>the number of elements in the <link linkend="GByteArray"><type>GByteArray</type></link>.
121
 
 
122
115
</simpara></listitem>
123
116
</varlistentry>
124
117
</variablelist></refsect2>
125
 
<refsect2>
126
 
<title><anchor id="g-byte-array-new" role="function"/>g_byte_array_new ()</title>
127
 
<indexterm><primary>g_byte_array_new</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_new                    (void);</programlisting>
 
118
<refsect2 id="g-byte-array-new" role="function">
 
119
<title>g_byte_array_new ()</title>
 
120
<indexterm zone="g-byte-array-new"><primary sortas="g_byte_array_new">g_byte_array_new</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_new                    (void);</programlisting>
128
121
<para>
129
122
Creates a new <link linkend="GByteArray"><type>GByteArray</type></link>.
130
123
</para><variablelist role="params">
131
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the new <link linkend="GByteArray"><type>GByteArray</type></link>.
132
 
 
133
 
 
 
124
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the new <link linkend="GByteArray"><type>GByteArray</type></link>.
134
125
</simpara></listitem></varlistentry>
135
126
</variablelist></refsect2>
136
 
<refsect2>
137
 
<title><anchor id="g-byte-array-sized-new" role="function"/>g_byte_array_sized_new ()</title>
138
 
<indexterm><primary>g_byte_array_sized_new</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_sized_new              (<link linkend="guint">guint</link> reserved_size);</programlisting>
 
127
<refsect2 id="g-byte-array-sized-new" role="function">
 
128
<title>g_byte_array_sized_new ()</title>
 
129
<indexterm zone="g-byte-array-sized-new"><primary sortas="g_byte_array_sized_new">g_byte_array_sized_new</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_sized_new              (<link linkend="guint">guint</link> reserved_size);</programlisting>
139
130
<para>
140
131
Creates a new <link linkend="GByteArray"><type>GByteArray</type></link> with <parameter>reserved_size</parameter> bytes preallocated. This
141
132
avoids frequent reallocation, if you are going to add many bytes to
142
133
the array. Note however that the size of the array is still 0.
143
134
</para><variablelist role="params">
144
 
<varlistentry><term><parameter>reserved_size</parameter>&nbsp;:</term>
 
135
<varlistentry><term><parameter>reserved_size</parameter>&#160;:</term>
145
136
<listitem><simpara>number of bytes preallocated.
146
137
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the new <link linkend="GByteArray"><type>GByteArray</type></link>.
148
 
 
149
 
 
 
138
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the new <link linkend="GByteArray"><type>GByteArray</type></link>.
150
139
</simpara></listitem></varlistentry>
151
140
</variablelist></refsect2>
152
 
<refsect2>
153
 
<title><anchor id="g-byte-array-append" role="function"/>g_byte_array_append ()</title>
154
 
<indexterm><primary>g_byte_array_append</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_append                 (<link linkend="GByteArray">GByteArray</link> *array,
 
141
<refsect2 id="g-byte-array-append" role="function">
 
142
<title>g_byte_array_append ()</title>
 
143
<indexterm zone="g-byte-array-append"><primary sortas="g_byte_array_append">g_byte_array_append</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_append                 (<link linkend="GByteArray">GByteArray</link> *array,
155
144
                                                         const <link linkend="guint8">guint8</link> *data,
156
145
                                                         <link linkend="guint">guint</link> len);</programlisting>
157
146
<para>
158
147
Adds the given bytes to the end of the <link linkend="GByteArray"><type>GByteArray</type></link>.
159
148
The array will grow in size automatically if necessary.
160
149
</para><variablelist role="params">
161
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
150
<varlistentry><term><parameter>array</parameter>&#160;:</term>
162
151
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
163
152
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
153
<varlistentry><term><parameter>data</parameter>&#160;:</term>
165
154
<listitem><simpara>the byte data to be added.
166
155
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
156
<varlistentry><term><parameter>len</parameter>&#160;:</term>
168
157
<listitem><simpara>the number of bytes to add.
169
158
</simpara></listitem></varlistentry>
170
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
171
 
 
172
 
 
 
159
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
173
160
</simpara></listitem></varlistentry>
174
161
</variablelist></refsect2>
175
 
<refsect2>
176
 
<title><anchor id="g-byte-array-prepend" role="function"/>g_byte_array_prepend ()</title>
177
 
<indexterm><primary>g_byte_array_prepend</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_prepend                (<link linkend="GByteArray">GByteArray</link> *array,
 
162
<refsect2 id="g-byte-array-prepend" role="function">
 
163
<title>g_byte_array_prepend ()</title>
 
164
<indexterm zone="g-byte-array-prepend"><primary sortas="g_byte_array_prepend">g_byte_array_prepend</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_prepend                (<link linkend="GByteArray">GByteArray</link> *array,
178
165
                                                         const <link linkend="guint8">guint8</link> *data,
179
166
                                                         <link linkend="guint">guint</link> len);</programlisting>
180
167
<para>
181
168
Adds the given data to the start of the <link linkend="GByteArray"><type>GByteArray</type></link>.
182
169
The array will grow in size automatically if necessary.
183
170
</para><variablelist role="params">
184
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
171
<varlistentry><term><parameter>array</parameter>&#160;:</term>
185
172
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
186
173
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
174
<varlistentry><term><parameter>data</parameter>&#160;:</term>
188
175
<listitem><simpara>the byte data to be added.
189
176
</simpara></listitem></varlistentry>
190
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
177
<varlistentry><term><parameter>len</parameter>&#160;:</term>
191
178
<listitem><simpara>the number of bytes to add.
192
179
</simpara></listitem></varlistentry>
193
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
194
 
 
195
 
 
 
180
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
196
181
</simpara></listitem></varlistentry>
197
182
</variablelist></refsect2>
198
 
<refsect2>
199
 
<title><anchor id="g-byte-array-remove-index" role="function"/>g_byte_array_remove_index ()</title>
200
 
<indexterm><primary>g_byte_array_remove_index</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_remove_index           (<link linkend="GByteArray">GByteArray</link> *array,
 
183
<refsect2 id="g-byte-array-remove-index" role="function">
 
184
<title>g_byte_array_remove_index ()</title>
 
185
<indexterm zone="g-byte-array-remove-index"><primary sortas="g_byte_array_remove_index">g_byte_array_remove_index</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_remove_index           (<link linkend="GByteArray">GByteArray</link> *array,
201
186
                                                         <link linkend="guint">guint</link> index_);</programlisting>
202
187
<para>
203
188
Removes the byte at the given index from a <link linkend="GByteArray"><type>GByteArray</type></link>.
204
189
The following bytes are moved down one place.
205
190
</para><variablelist role="params">
206
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
191
<varlistentry><term><parameter>array</parameter>&#160;:</term>
207
192
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
208
193
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>index_</parameter>&nbsp;:</term>
 
194
<varlistentry><term><parameter>index_</parameter>&#160;:</term>
210
195
<listitem><simpara>the index of the byte to remove.
211
196
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
213
 
 
214
 
 
 
197
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
215
198
</simpara></listitem></varlistentry>
216
199
</variablelist></refsect2>
217
 
<refsect2>
218
 
<title><anchor id="g-byte-array-remove-index-fast" role="function"/>g_byte_array_remove_index_fast ()</title>
219
 
<indexterm><primary>g_byte_array_remove_index_fast</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_remove_index_fast      (<link linkend="GByteArray">GByteArray</link> *array,
 
200
<refsect2 id="g-byte-array-remove-index-fast" role="function">
 
201
<title>g_byte_array_remove_index_fast ()</title>
 
202
<indexterm zone="g-byte-array-remove-index-fast"><primary sortas="g_byte_array_remove_index_fast">g_byte_array_remove_index_fast</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_remove_index_fast      (<link linkend="GByteArray">GByteArray</link> *array,
220
203
                                                         <link linkend="guint">guint</link> index_);</programlisting>
221
204
<para>
222
205
Removes the byte at the given index from a <link linkend="GByteArray"><type>GByteArray</type></link>.
224
207
does not preserve the order of the <link linkend="GByteArray"><type>GByteArray</type></link>. But it is faster than
225
208
<link linkend="g-byte-array-remove-index"><function>g_byte_array_remove_index()</function></link>.
226
209
</para><variablelist role="params">
227
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
210
<varlistentry><term><parameter>array</parameter>&#160;:</term>
228
211
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
229
212
</simpara></listitem></varlistentry>
230
 
<varlistentry><term><parameter>index_</parameter>&nbsp;:</term>
 
213
<varlistentry><term><parameter>index_</parameter>&#160;:</term>
231
214
<listitem><simpara>the index of the byte to remove.
232
215
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
234
 
 
235
 
 
 
216
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
236
217
</simpara></listitem></varlistentry>
237
218
</variablelist></refsect2>
238
 
<refsect2>
239
 
<title><anchor id="g-byte-array-remove-range" role="function" condition="since:2.4"/>g_byte_array_remove_range ()</title>
240
 
<indexterm role="2.4"><primary>g_byte_array_remove_range</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_remove_range           (<link linkend="GByteArray">GByteArray</link> *array,
 
219
<refsect2 id="g-byte-array-remove-range" role="function" condition="since:2.4">
 
220
<title>g_byte_array_remove_range ()</title>
 
221
<indexterm zone="g-byte-array-remove-range" role="2.4"><primary sortas="g_byte_array_remove_range">g_byte_array_remove_range</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_remove_range           (<link linkend="GByteArray">GByteArray</link> *array,
241
222
                                                         <link linkend="guint">guint</link> index_,
242
223
                                                         <link linkend="guint">guint</link> length);</programlisting>
243
224
<para>
244
225
Removes the given number of bytes starting at the given index from a
245
226
<link linkend="GByteArray"><type>GByteArray</type></link>.  The following elements are moved to close the gap.
246
227
</para><variablelist role="params">
247
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
228
<varlistentry><term><parameter>array</parameter>&#160;:</term>
248
229
<listitem><simpara>a <parameter>GByteArray</parameter>.
249
230
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>index_</parameter>&nbsp;:</term>
 
231
<varlistentry><term><parameter>index_</parameter>&#160;:</term>
251
232
<listitem><simpara>the index of the first byte to remove.
252
233
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
 
234
<varlistentry><term><parameter>length</parameter>&#160;:</term>
254
235
<listitem><simpara>the number of bytes to remove.
255
236
</simpara></listitem></varlistentry>
256
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
 
237
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
257
238
</simpara></listitem></varlistentry>
258
 
</variablelist><para role="since">Since 2.4
259
 
 
260
 
 
261
 
</para></refsect2>
262
 
<refsect2>
263
 
<title><anchor id="g-byte-array-sort" role="function"/>g_byte_array_sort ()</title>
264
 
<indexterm><primary>g_byte_array_sort</primary></indexterm><programlisting><link linkend="void">void</link>                g_byte_array_sort                   (<link linkend="GByteArray">GByteArray</link> *array,
 
239
</variablelist><para role="since">Since 2.4</para></refsect2>
 
240
<refsect2 id="g-byte-array-sort" role="function">
 
241
<title>g_byte_array_sort ()</title>
 
242
<indexterm zone="g-byte-array-sort"><primary sortas="g_byte_array_sort">g_byte_array_sort</primary></indexterm><programlisting><link linkend="void">void</link>                g_byte_array_sort                   (<link linkend="GByteArray">GByteArray</link> *array,
265
243
                                                         <link linkend="GCompareFunc">GCompareFunc</link> compare_func);</programlisting>
266
244
<para>
267
245
Sorts a byte array, using <parameter>compare_func</parameter> which should be a <link linkend="qsort"><function>qsort()</function></link>-style
268
 
comparison function (returns less than zero for first arg is less than second 
269
 
arg, zero for equal, greater than zero if first arg is greater than second 
 
246
comparison function (returns less than zero for first arg is less than second
 
247
arg, zero for equal, greater than zero if first arg is greater than second
270
248
arg).
271
249
</para>
272
250
<para>
273
251
If two array elements compare equal, their order in the sorted array is
274
252
undefined.
275
253
</para><variablelist role="params">
276
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
254
<varlistentry><term><parameter>array</parameter>&#160;:</term>
277
255
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
278
256
</simpara></listitem></varlistentry>
279
 
<varlistentry><term><parameter>compare_func</parameter>&nbsp;:</term>
 
257
<varlistentry><term><parameter>compare_func</parameter>&#160;:</term>
280
258
<listitem><simpara>comparison function.
281
 
 
282
 
 
283
259
</simpara></listitem></varlistentry>
284
260
</variablelist></refsect2>
285
 
<refsect2>
286
 
<title><anchor id="g-byte-array-sort-with-data" role="function"/>g_byte_array_sort_with_data ()</title>
287
 
<indexterm><primary>g_byte_array_sort_with_data</primary></indexterm><programlisting><link linkend="void">void</link>                g_byte_array_sort_with_data         (<link linkend="GByteArray">GByteArray</link> *array,
 
261
<refsect2 id="g-byte-array-sort-with-data" role="function">
 
262
<title>g_byte_array_sort_with_data ()</title>
 
263
<indexterm zone="g-byte-array-sort-with-data"><primary sortas="g_byte_array_sort_with_data">g_byte_array_sort_with_data</primary></indexterm><programlisting><link linkend="void">void</link>                g_byte_array_sort_with_data         (<link linkend="GByteArray">GByteArray</link> *array,
288
264
                                                         <link linkend="GCompareDataFunc">GCompareDataFunc</link> compare_func,
289
265
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
290
266
<para>
291
267
Like <link linkend="g-byte-array-sort"><function>g_byte_array_sort()</function></link>, but the comparison function takes an extra user data
292
268
argument.
293
269
</para><variablelist role="params">
294
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
270
<varlistentry><term><parameter>array</parameter>&#160;:</term>
295
271
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
296
272
</simpara></listitem></varlistentry>
297
 
<varlistentry><term><parameter>compare_func</parameter>&nbsp;:</term>
 
273
<varlistentry><term><parameter>compare_func</parameter>&#160;:</term>
298
274
<listitem><simpara>comparison function.
299
275
</simpara></listitem></varlistentry>
300
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
276
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
301
277
<listitem><simpara>data to pass to <parameter>compare_func</parameter>.
302
 
 
303
 
 
304
278
</simpara></listitem></varlistentry>
305
279
</variablelist></refsect2>
306
 
<refsect2>
307
 
<title><anchor id="g-byte-array-set-size" role="function"/>g_byte_array_set_size ()</title>
308
 
<indexterm><primary>g_byte_array_set_size</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_set_size               (<link linkend="GByteArray">GByteArray</link> *array,
 
280
<refsect2 id="g-byte-array-set-size" role="function">
 
281
<title>g_byte_array_set_size ()</title>
 
282
<indexterm zone="g-byte-array-set-size"><primary sortas="g_byte_array_set_size">g_byte_array_set_size</primary></indexterm><programlisting><link linkend="GByteArray">GByteArray</link>*         g_byte_array_set_size               (<link linkend="GByteArray">GByteArray</link> *array,
309
283
                                                         <link linkend="guint">guint</link> length);</programlisting>
310
284
<para>
311
285
Sets the size of the <link linkend="GByteArray"><type>GByteArray</type></link>, expanding it if necessary.
312
286
</para><variablelist role="params">
313
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
287
<varlistentry><term><parameter>array</parameter>&#160;:</term>
314
288
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
315
289
</simpara></listitem></varlistentry>
316
 
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
 
290
<varlistentry><term><parameter>length</parameter>&#160;:</term>
317
291
<listitem><simpara>the new size of the <link linkend="GByteArray"><type>GByteArray</type></link>.
318
292
</simpara></listitem></varlistentry>
319
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
320
 
 
321
 
 
 
293
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GByteArray"><type>GByteArray</type></link>.
322
294
</simpara></listitem></varlistentry>
323
295
</variablelist></refsect2>
324
 
<refsect2>
325
 
<title><anchor id="g-byte-array-free" role="function"/>g_byte_array_free ()</title>
326
 
<indexterm><primary>g_byte_array_free</primary></indexterm><programlisting><link linkend="guint8">guint8</link>*             g_byte_array_free                   (<link linkend="GByteArray">GByteArray</link> *array,
 
296
<refsect2 id="g-byte-array-free" role="function">
 
297
<title>g_byte_array_free ()</title>
 
298
<indexterm zone="g-byte-array-free"><primary sortas="g_byte_array_free">g_byte_array_free</primary></indexterm><programlisting><link linkend="guint8">guint8</link>*             g_byte_array_free                   (<link linkend="GByteArray">GByteArray</link> *array,
327
299
                                                         <link linkend="gboolean">gboolean</link> free_segment);</programlisting>
328
300
<para>
329
301
Frees the memory allocated by the <link linkend="GByteArray"><type>GByteArray</type></link>.
330
 
If <parameter>free_segment</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> it frees the actual byte data.
 
302
If <parameter>free_segment</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> it frees the actual byte data.
331
303
</para><variablelist role="params">
332
 
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
 
304
<varlistentry><term><parameter>array</parameter>&#160;:</term>
333
305
<listitem><simpara>a <link linkend="GByteArray"><type>GByteArray</type></link>.
334
306
</simpara></listitem></varlistentry>
335
 
<varlistentry><term><parameter>free_segment</parameter>&nbsp;:</term>
336
 
<listitem><simpara>if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> the actual byte data is freed as well.
 
307
<varlistentry><term><parameter>free_segment</parameter>&#160;:</term>
 
308
<listitem><simpara>if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> the actual byte data is freed as well.
337
309
</simpara></listitem></varlistentry>
338
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the element data if <parameter>free_segment</parameter> is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, otherwise <link linkend="NULL:CAPS"><literal>NULL</literal></link>
339
 
 
340
 
 
 
310
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the element data if <parameter>free_segment</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, otherwise <link linkend="NULL--CAPS"><literal>NULL</literal></link>
341
311
</simpara></listitem></varlistentry>
342
312
</variablelist></refsect2>
343
313
 
346
316
 
347
317
 
348
318
 
349
 
 
350
 
<refsect1><refsect2 /><refsect2 /></refsect1>
351
319
</refentry>