|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/glib/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Arrays</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GLib Reference Manual">
<link rel="up" href="glib-data-types.html" title="GLib Data Types">
<link rel="prev" href="glib-String-Chunks.html" title="String Chunks">
<link rel="next" href="glib-Pointer-Arrays.html" title="Pointer Arrays">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="glib.html" title="GLib Overview">
<link rel="chapter" href="glib-fundamentals.html" title="GLib Fundamentals">
<link rel="chapter" href="glib-core.html" title="GLib Core Application Support">
<link rel="chapter" href="glib-utilities.html" title="GLib Utilities">
<link rel="chapter" href="glib-data-types.html" title="GLib Data Types">
<link rel="chapter" href="tools.html" title="GLib Tools">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
<link rel="index" href="ix08.html" title="Index of new symbols in 2.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="glib-String-Chunks.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="glib-data-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GLib Reference Manual</th>
<td><a accesskey="n" href="glib-Pointer-Arrays.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3256756" class="shortcut">Top</a>
 | 
<a href="#id3257249" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="glib-Arrays"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3256756"></a><span class="refentrytitle">Arrays</span>
</h2>
<p>Arrays — arrays of arbitrary elements which grow automatically as elements are added.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <glib.h>
<a href="glib-Arrays.html#GArray">GArray</a>;
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-new">g_array_new</a> (<a href="glib-Basic-Types.html#gboolean">gboolean</a> zero_terminated,
<a href="glib-Basic-Types.html#gboolean">gboolean</a> clear_,
<a href="glib-Basic-Types.html#guint">guint</a> element_size);
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-sized-new">g_array_sized_new</a> (<a href="glib-Basic-Types.html#gboolean">gboolean</a> zero_terminated,
<a href="glib-Basic-Types.html#gboolean">gboolean</a> clear_,
<a href="glib-Basic-Types.html#guint">guint</a> element_size,
<a href="glib-Basic-Types.html#guint">guint</a> reserved_size);
#define <a href="glib-Arrays.html#g-array-append-val">g_array_append_val</a> (a,v)
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-append-vals">g_array_append_vals</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#gconstpointer">gconstpointer</a> data,
<a href="glib-Basic-Types.html#guint">guint</a> len);
#define <a href="glib-Arrays.html#g-array-prepend-val">g_array_prepend_val</a> (a,v)
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-prepend-vals">g_array_prepend_vals</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#gconstpointer">gconstpointer</a> data,
<a href="glib-Basic-Types.html#guint">guint</a> len);
#define <a href="glib-Arrays.html#g-array-insert-val">g_array_insert_val</a> (a,i,v)
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-insert-vals">g_array_insert_vals</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_,
<a href="glib-Basic-Types.html#gconstpointer">gconstpointer</a> data,
<a href="glib-Basic-Types.html#guint">guint</a> len);
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-remove-index">g_array_remove_index</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_);
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-remove-index-fast">g_array_remove_index_fast</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_);
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-remove-range">g_array_remove_range</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_,
<a href="glib-Basic-Types.html#guint">guint</a> length);
void <a href="glib-Arrays.html#g-array-sort">g_array_sort</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Doubly-Linked-Lists.html#GCompareFunc">GCompareFunc</a> compare_func);
void <a href="glib-Arrays.html#g-array-sort-with-data">g_array_sort_with_data</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Doubly-Linked-Lists.html#GCompareDataFunc">GCompareDataFunc</a> compare_func,
<a href="glib-Basic-Types.html#gpointer">gpointer</a> user_data);
#define <a href="glib-Arrays.html#g-array-index">g_array_index</a> (a,t,i)
<a href="glib-Arrays.html#GArray">GArray</a>* <a href="glib-Arrays.html#g-array-set-size">g_array_set_size</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> length);
<a href="glib-Basic-Types.html#gchar">gchar</a>* <a href="glib-Arrays.html#g-array-free">g_array_free</a> (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#gboolean">gboolean</a> free_segment);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3257249"></a><h2>Description</h2>
<p>
Arrays are similar to standard C arrays, except that they grow automatically
as elements are added.
</p>
<p>
Array elements can be of any size (though all elements of one array are the
same size), and the array can be automatically cleared to '0's and
zero-terminated.
</p>
<p>
To create a new array use <a href="glib-Arrays.html#g-array-new"><code class="function">g_array_new()</code></a>.
</p>
<p>
To add elements to an array, use <a href="glib-Arrays.html#g-array-append-val"><code class="function">g_array_append_val()</code></a>, <a href="glib-Arrays.html#g-array-append-vals"><code class="function">g_array_append_vals()</code></a>,
<a href="glib-Arrays.html#g-array-prepend-val"><code class="function">g_array_prepend_val()</code></a>, and <a href="glib-Arrays.html#g-array-prepend-vals"><code class="function">g_array_prepend_vals()</code></a>.
</p>
<p>
To access an element of an array, use <a href="glib-Arrays.html#g-array-index"><code class="function">g_array_index()</code></a>.
</p>
<p>
To set the size of an array, use <a href="glib-Arrays.html#g-array-set-size"><code class="function">g_array_set_size()</code></a>.
</p>
<p>
To free an array, use <a href="glib-Arrays.html#g-array-free"><code class="function">g_array_free()</code></a>.
</p>
<div class="example">
<a name="id3257373"></a><p class="title"><b>Example 5. Using a <span class="structname">GArray</span> to store <span class="type">gint</span> values</b></p>
<pre class="programlisting">
GArray *garray;
gint i;
/* We create a new array to store gint values.
We don't want it zero-terminated or cleared to 0's. */
garray = g_array_new (FALSE, FALSE, sizeof (gint));
for (i = 0; i < 10000; i++)
g_array_append_val (garray, i);
for (i = 0; i < 10000; i++)
if (g_array_index (garray, gint, i) != i)
g_print ("ERROR: got %d instead of %d\n",
g_array_index (garray, gint, i), i);
g_array_free (garray, TRUE);
</pre>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3257392"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3257411"></a><h3>
<a name="GArray"></a>GArray</h3>
<a class="indexterm" name="id3257424"></a><pre class="programlisting">typedef struct {
gchar *data;
guint len;
} GArray;
</pre>
<p>
Contains the public fields of an Array.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a href="glib-Basic-Types.html#gchar">gchar</a> *<em class="structfield"><code>data</code></em>;</span></td>
<td>a pointer to the element data. The data may be moved as elements are
added to the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><a href="glib-Basic-Types.html#guint">guint</a> <em class="structfield"><code>len</code></em>;</span></td>
<td>the number of elements in the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3257509"></a><h3>
<a name="g-array-new"></a>g_array_new ()</h3>
<a class="indexterm" name="id3257521"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_new (<a href="glib-Basic-Types.html#gboolean">gboolean</a> zero_terminated,
<a href="glib-Basic-Types.html#gboolean">gboolean</a> clear_,
<a href="glib-Basic-Types.html#guint">guint</a> element_size);</pre>
<p>
Creates a new <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>zero_terminated</code></em> :</span></td>
<td>
<a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the array should have an extra element at the end
which is set to 0.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>clear_</code></em> :</span></td>
<td>
<a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> elements should be automatically cleared to 0
when they are allocated.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>element_size</code></em> :</span></td>
<td>the size of each element in bytes.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the new <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3257666"></a><h3>
<a name="g-array-sized-new"></a>g_array_sized_new ()</h3>
<a class="indexterm" name="id3257679"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_sized_new (<a href="glib-Basic-Types.html#gboolean">gboolean</a> zero_terminated,
<a href="glib-Basic-Types.html#gboolean">gboolean</a> clear_,
<a href="glib-Basic-Types.html#guint">guint</a> element_size,
<a href="glib-Basic-Types.html#guint">guint</a> reserved_size);</pre>
<p>
Creates a new <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> with <em class="parameter"><code>reserved_size</code></em> elements
preallocated. This avoids frequent reallocation, if you are going to
add many elements to the array. Note however that the size of the
array is still 0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>zero_terminated</code></em> :</span></td>
<td>
<a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the array should have an extra element at the end with all bits cleared.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>clear_</code></em> :</span></td>
<td>
<a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if all bits in the array should be cleared to 0 on allocation.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>element_size</code></em> :</span></td>
<td>size of each element in the array.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>reserved_size</code></em> :</span></td>
<td>number of elements preallocated.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the new <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3257846"></a><h3>
<a name="g-array-append-val"></a>g_array_append_val()</h3>
<a class="indexterm" name="id3257860"></a><pre class="programlisting">#define g_array_append_val(a,v)</pre>
<p>
Adds the value on to the end of the array.
The array will grow in size automatically if necessary.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
<a href="glib-Arrays.html#g-array-append-val"><code class="function">g_array_append_val()</code></a> is a macro which uses a reference to the value
parameter <em class="parameter"><code>v</code></em>. This means that you cannot use it with literal values
such as "27". You must use variables.
</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>a</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>v</code></em> :</span></td>
<td>the value to append to the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3257967"></a><h3>
<a name="g-array-append-vals"></a>g_array_append_vals ()</h3>
<a class="indexterm" name="id3257980"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_append_vals (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#gconstpointer">gconstpointer</a> data,
<a href="glib-Basic-Types.html#guint">guint</a> len);</pre>
<p>
Adds <em class="parameter"><code>len</code></em> elements onto the end of the array.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>a pointer to the elements to append to the end of the array.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>len</code></em> :</span></td>
<td>the number of elements to append.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258103"></a><h3>
<a name="g-array-prepend-val"></a>g_array_prepend_val()</h3>
<a class="indexterm" name="id3258116"></a><pre class="programlisting">#define g_array_prepend_val(a,v)</pre>
<p>
Adds the value on to the start of the array.
The array will grow in size automatically if necessary.
</p>
<p>
This operation is slower than <a href="glib-Arrays.html#g-array-append-val"><code class="function">g_array_append_val()</code></a> since the existing elements
in the array have to be moved to make space for the new element.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
<a href="glib-Arrays.html#g-array-prepend-val"><code class="function">g_array_prepend_val()</code></a> is a macro which uses a reference to the value
parameter <em class="parameter"><code>v</code></em>. This means that you cannot use it with literal values
such as "27". You must use variables.
</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>a</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>v</code></em> :</span></td>
<td>the value to prepend to the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258240"></a><h3>
<a name="g-array-prepend-vals"></a>g_array_prepend_vals ()</h3>
<a class="indexterm" name="id3258253"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_prepend_vals (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#gconstpointer">gconstpointer</a> data,
<a href="glib-Basic-Types.html#guint">guint</a> len);</pre>
<p>
Adds <em class="parameter"><code>len</code></em> elements onto the start of the array.
</p>
<p>
This operation is slower than <a href="glib-Arrays.html#g-array-append-vals"><code class="function">g_array_append_vals()</code></a> since the existing elements
in the array have to be moved to make space for the new elements.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>a pointer to the elements to prepend to the start of the array.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>len</code></em> :</span></td>
<td>the number of elements to prepend.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258392"></a><h3>
<a name="g-array-insert-val"></a>g_array_insert_val()</h3>
<a class="indexterm" name="id3258405"></a><pre class="programlisting">#define g_array_insert_val(a,i,v)</pre>
<p>
Inserts an element into an array at the given index.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
<a href="glib-Arrays.html#g-array-insert-val"><code class="function">g_array_insert_val()</code></a> is a macro which uses a reference to the value
parameter <em class="parameter"><code>v</code></em>. This means that you cannot use it with literal values
such as "27". You must use variables.
</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>a</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td>the index to place the element at.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>v</code></em> :</span></td>
<td>the value to insert into the array.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258518"></a><h3>
<a name="g-array-insert-vals"></a>g_array_insert_vals ()</h3>
<a class="indexterm" name="id3258531"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_insert_vals (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_,
<a href="glib-Basic-Types.html#gconstpointer">gconstpointer</a> data,
<a href="glib-Basic-Types.html#guint">guint</a> len);</pre>
<p>
Inserts <em class="parameter"><code>len</code></em> elements into a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> at the given index.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
<td>the index to place the elements at.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>a pointer to the elements to insert.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>len</code></em> :</span></td>
<td>the number of elements to insert.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258683"></a><h3>
<a name="g-array-remove-index"></a>g_array_remove_index ()</h3>
<a class="indexterm" name="id3258696"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_remove_index (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_);</pre>
<p>
Removes the element at the given index from a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
The following elements are moved down one place.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
<td>the index of the element to remove.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258800"></a><h3>
<a name="g-array-remove-index-fast"></a>g_array_remove_index_fast ()</h3>
<a class="indexterm" name="id3258814"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_remove_index_fast (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_);</pre>
<p>
Removes the element at the given index from a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
The last element in the array is used to fill in the space, so this function
does not preserve the order of the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. But it is faster than
<a href="glib-Arrays.html#g-array-remove-index"><code class="function">g_array_remove_index()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <em class="parameter"><code>GArray</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
<td>the index of the element to remove.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3258935"></a><h3>
<a name="g-array-remove-range"></a>g_array_remove_range ()</h3>
<a class="indexterm" name="id3258950"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_remove_range (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> index_,
<a href="glib-Basic-Types.html#guint">guint</a> length);</pre>
<p>
Removes the given number of elements starting at the given index from a
<a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. The following elements are moved to close the gap.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <em class="parameter"><code>GArray</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
<td>the index of the first element to remove.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>length</code></em> :</span></td>
<td>the number of elements to remove.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3259078"></a><h3>
<a name="g-array-sort"></a>g_array_sort ()</h3>
<a class="indexterm" name="id3259091"></a><pre class="programlisting">void g_array_sort (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Doubly-Linked-Lists.html#GCompareFunc">GCompareFunc</a> compare_func);</pre>
<p>
Sorts a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> using <em class="parameter"><code>compare_func</code></em> which should be a <code class="function">qsort()</code>-style comparison
function (returns less than zero for first arg is less than second arg,
zero for equal, greater zero if first arg is greater than second arg).
</p>
<p>
If two array elements compare equal, their order in the sorted array is
undefined.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>compare_func</code></em> :</span></td>
<td>comparison function.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3259200"></a><h3>
<a name="g-array-sort-with-data"></a>g_array_sort_with_data ()</h3>
<a class="indexterm" name="id3259213"></a><pre class="programlisting">void g_array_sort_with_data (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Doubly-Linked-Lists.html#GCompareDataFunc">GCompareDataFunc</a> compare_func,
<a href="glib-Basic-Types.html#gpointer">gpointer</a> user_data);</pre>
<p>
Like <a href="glib-Arrays.html#g-array-sort"><code class="function">g_array_sort()</code></a>, but the comparison function receives an extra user data
argument.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>compare_func</code></em> :</span></td>
<td>comparison function.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>data to pass to <em class="parameter"><code>compare_func</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3259329"></a><h3>
<a name="g-array-index"></a>g_array_index()</h3>
<a class="indexterm" name="id3259342"></a><pre class="programlisting">#define g_array_index(a,t,i)</pre>
<p>
Returns the element of a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> at the given index.
The return value is cast to the given type.
</p>
<div class="example">
<a name="id3259366"></a><p class="title"><b>Example 6. Getting a pointer to an element in a <span class="structname">GArray</span></b></p>
<pre class="programlisting">
EDayViewEvent *event;
/* This gets a pointer to the 3rd element in the array of EDayViewEvent
structs. */
event = &g_array_index (events, EDayViewEvent, 3);
</pre>
</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>a</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>t</code></em> :</span></td>
<td>the type of the elements.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td>the index of the element to return.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the element of the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> at the index given by <em class="parameter"><code>i</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3259464"></a><h3>
<a name="g-array-set-size"></a>g_array_set_size ()</h3>
<a class="indexterm" name="id3259477"></a><pre class="programlisting"><a href="glib-Arrays.html#GArray">GArray</a>* g_array_set_size (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#guint">guint</a> length);</pre>
<p>
Sets the size of the array, expanding it if necessary.
If the array was created with <em class="parameter"><code>clear_</code></em> set to <a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the new elements are set to 0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>length</code></em> :</span></td>
<td>the new size of the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3259597"></a><h3>
<a name="g-array-free"></a>g_array_free ()</h3>
<a class="indexterm" name="id3259610"></a><pre class="programlisting"><a href="glib-Basic-Types.html#gchar">gchar</a>* g_array_free (<a href="glib-Arrays.html#GArray">GArray</a> *array,
<a href="glib-Basic-Types.html#gboolean">gboolean</a> free_segment);</pre>
<p>
Frees the memory allocated for the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
If <em class="parameter"><code>free_segment</code></em> is <a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> it frees the memory block holding the elements
as well. Pass <a href="glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if you want to free the <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a> wrapper but preserve
the underlying array for use elsewhere.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
If array elements contain dynamically-allocated memory, they should be freed
first.
</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>array</code></em> :</span></td>
<td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>free_segment</code></em> :</span></td>
<td>if <a href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> the actual element data is freed as well.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the element data if <em class="parameter"><code>free_segment</code></em> is <a href="glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, otherwise <a href="glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>