<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Arrays</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="GLib Reference Manual"><link rel="up" href="glib-data-types.html" title="GLib Data Types"><link rel="previous" href="glib-String-Chunks.html" title="String Chunks"><link rel="next" href="glib-Pointer-Arrays.html" title="Pointer Arrays"><link rel="chapter" href="glib.html" title="GLib Overview"><link rel="refentry" href="glib-building.html" title="Compiling the GLib package"><link rel="refentry" href="glib-cross-compiling.html" title="Cross-compiling the GLib package"><link rel="refentry" href="glib-compiling.html" title="Compiling GLib Applications"><link rel="refentry" href="glib-running.html" title="Running GLib Applications"><link rel="refentry" href="glib-changes.html" title="Changes to GLib"><link rel="refentry" href="glib-resources.html" title="Mailing lists and bug reports"><link rel="chapter" href="glib-fundamentals.html" title="GLib Fundamentals"><link rel="refentry" href="glib-Basic-Types.html" title="Basic Types"><link rel="refentry" href="glib-Limits-of-Basic-Types.html" title="Limits of Basic Types"><link rel="refentry" href="glib-Standard-Macros.html" title="Standard Macros"><link rel="refentry" href="glib-Type-Conversion-Macros.html" title="Type Conversion Macros"><link rel="refentry" href="glib-Byte-Order-Macros.html" title="Byte Order Macros"><link rel="refentry" href="glib-Numerical-Definitions.html" title="Numerical Definitions"><link rel="refentry" href="glib-Miscellaneous-Macros.html" title="Miscellaneous Macros"><link rel="refentry" href="glib-Atomic-Operations.html" title="Atomic Operations"><link rel="chapter" href="glib-core.html" title="GLib Core Application Support"><link rel="refentry" href="glib-The-Main-Event-Loop.html" title="The Main Event Loop"><link rel="refentry" href="glib-Threads.html" title=" Threads"><link rel="refentry" href="glib-Thread-Pools.html" title="Thread Pools"><link rel="refentry" href="glib-Asynchronous-Queues.html" title="Asynchronous Queues"><link rel="refentry" href="glib-Dynamic-Loading-of-Modules.html" title="Dynamic Loading of Modules"><link rel="refentry" href="glib-Memory-Allocation.html" title="Memory Allocation"><link rel="refentry" href="glib-IO-Channels.html" title="IO Channels"><link rel="refentry" href="glib-Error-Reporting.html" title="Error Reporting"><link rel="refentry" href="glib-Warnings-and-Assertions.html" title="Message Output and Debugging Functions"><link rel="refentry" href="glib-Message-Logging.html" title="Message Logging"><link rel="chapter" href="glib-utilities.html" title="GLib Utilities"><link rel="refentry" href="glib-String-Utility-Functions.html" title="String Utility Functions"><link rel="refentry" href="glib-Character-Set-Conversion.html" title="Character Set Conversion"><link rel="refentry" href="glib-Unicode-Manipulation.html" title="Unicode Manipulation"><link rel="refentry" href="glib-I18N.html" title="Internationalization"><link rel="refentry" href="glib-Date-and-Time-Functions.html" title="Date and Time Functions"><link rel="refentry" href="glib-Random-Numbers.html" title="Random Numbers"><link rel="refentry" href="glib-Hook-Functions.html" title="Hook Functions"><link rel="refentry" href="glib-Miscellaneous-Utility-Functions.html" title="Miscellaneous Utility Functions"><link rel="refentry" href="glib-Lexical-Scanner.html" title="Lexical Scanner"><link rel="refentry" href="glib-Automatic-String-Completion.html" title="Automatic String Completion"><link rel="refentry" href="glib-Timers.html" title="Timers"><link rel="refentry" href="glib-Spawning-Processes.html" title="Spawning Processes"><link rel="refentry" href="glib-File-Utilities.html" title="File Utilities"><link rel="refentry" href="glib-Shell-related-Utilities.html" title="Shell-related Utilities"><link rel="refentry" href="glib-Glob-style-pattern-matching.html" title="Glob-style pattern matching"><link rel="refentry" href="glib-Simple-XML-Subset-Parser.html" title="Simple XML Subset Parser"><link rel="refentry" href="glib-Windows-Compatability-Functions.html" title="Windows Compatibility Functions"><link rel="chapter" href="glib-data-types.html" title="GLib Data Types"><link rel="refentry" href="glib-Memory-Chunks.html" title="Memory Chunks"><link rel="refentry" href="glib-Doubly-Linked-Lists.html" title="Doubly-Linked Lists"><link rel="refentry" href="glib-Singly-Linked-Lists.html" title="Singly-Linked Lists"><link rel="refentry" href="glib-Double-ended-Queues.html" title="Double-ended Queues"><link rel="refentry" href="glib-Trash-Stacks.html" title="Trash Stacks"><link rel="refentry" href="glib-Hash-Tables.html" title="Hash Tables"><link rel="refentry" href="glib-Strings.html" title="Strings"><link rel="refentry" href="glib-String-Chunks.html" title="String Chunks"><link rel="refentry" href="glib-Arrays.html" title="Arrays"><link rel="refentry" href="glib-Pointer-Arrays.html" title="Pointer Arrays"><link rel="refentry" href="glib-Byte-Arrays.html" title="Byte Arrays"><link rel="refentry" href="glib-Balanced-Binary-Trees.html" title="Balanced Binary Trees"><link rel="refentry" href="glib-N-ary-Trees.html" title="N-ary Trees"><link rel="refentry" href="glib-Quarks.html" title="Quarks"><link rel="refentry" href="glib-Keyed-Data-Lists.html" title="Keyed Data Lists"><link rel="refentry" href="glib-Datasets.html" title="Datasets"><link rel="refentry" href="glib-Relations-and-Tuples.html" title="Relations and Tuples"><link rel="refentry" href="glib-Caches.html" title="Caches"><link rel="refentry" href="glib-Memory-Allocators.html" title="Memory Allocators"><link rel="chapter" href="tools.html" title="GLib Tools"><link rel="refentry" href="glib-gettextize.html" title="glib-gettextize"><link rel="index" href="ix01.html" title="Index"><link rel="section" href="glib-Arrays.html#id3290311" title="Description"><link rel="section" href="glib-Arrays.html#id3290450" title="Details"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" 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></table><div class="refentry" lang="en"><a name="glib-Arrays"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">Arrays</span></h2><p>Arrays — arrays of arbitrary elements which grow automatically as elements are added.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis"> #include <glib.h> struct <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="id3290311"></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"><tt class="function">g_array_new()</tt></a>. </p><p> To add elements to an array, use <a href="glib-Arrays.html#g-array-append-val"><tt class="function">g_array_append_val()</tt></a>, <a href="glib-Arrays.html#g-array-append-vals"><tt class="function">g_array_append_vals()</tt></a>, <a href="glib-Arrays.html#g-array-prepend-val"><tt class="function">g_array_prepend_val()</tt></a>, and <a href="glib-Arrays.html#g-array-prepend-vals"><tt class="function">g_array_prepend_vals()</tt></a>. </p><p> To access an element of an array, use <a href="glib-Arrays.html#g-array-index"><tt class="function">g_array_index()</tt></a>. </p><p> To set the size of an array, use <a href="glib-Arrays.html#g-array-set-size"><tt class="function">g_array_set_size()</tt></a>. </p><p> To free an array, use <a href="glib-Arrays.html#g-array-free"><tt class="function">g_array_free()</tt></a>. </p><div class="example"><a name="id3290431"></a><p class="title"><b>Example 3. 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="id3290450"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3290466"></a><h3><a name="GArray"></a>struct GArray</h3><a class="indexterm" name="id3290476"></a><pre class="programlisting">struct GArray { gchar *data; guint len; }; </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> *<i class="structfield"><tt>data</tt></i></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> <i class="structfield"><tt>len</tt></i></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="id3290558"></a><h3><a name="g-array-new"></a>g_array_new ()</h3><a class="indexterm" name="id3290568"></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"><i class="parameter"><tt>zero_terminated</tt></i> :</span></td><td><tt class="literal">TRUE</tt> if the array should have an extra element at the end which is set to 0. </td></tr><tr><td><span class="term"><i class="parameter"><tt>clear_</tt></i> :</span></td><td><tt class="literal">TRUE</tt> 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"><i class="parameter"><tt>element_size</tt></i> :</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="id3290704"></a><h3><a name="g-array-sized-new"></a>g_array_sized_new ()</h3><a class="indexterm" name="id3290715"></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 <i class="parameter"><tt>reserved_size</tt></i> 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"><i class="parameter"><tt>zero_terminated</tt></i> :</span></td><td><tt class="literal">TRUE</tt> if the array should have an extra element at the end with all bits cleared. </td></tr><tr><td><span class="term"><i class="parameter"><tt>clear_</tt></i> :</span></td><td><tt class="literal">TRUE</tt> if all bits in the array should be cleared to 0 on allocation. </td></tr><tr><td><span class="term"><i class="parameter"><tt>element_size</tt></i> :</span></td><td>size of each element in the array. </td></tr><tr><td><span class="term"><i class="parameter"><tt>reserved_size</tt></i> :</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="id3290874"></a><h3><a name="g-array-append-val"></a>g_array_append_val()</h3><a class="indexterm" name="id3290885"></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"><tt class="function">g_array_append_val()</tt></a> is a macro which uses a reference to the value parameter <i class="parameter"><tt>v</tt></i>. 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"><i class="parameter"><tt>a</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>v</tt></i> :</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="id3290992"></a><h3><a name="g-array-append-vals"></a>g_array_append_vals ()</h3><a class="indexterm" name="id3291003"></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 <i class="parameter"><tt>len</tt></i> 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"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>a pointer to the elements to append to the end of the array. </td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</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="id3291126"></a><h3><a name="g-array-prepend-val"></a>g_array_prepend_val()</h3><a class="indexterm" name="id3291137"></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"><tt class="function">g_array_append_val()</tt></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"><tt class="function">g_array_prepend_val()</tt></a> is a macro which uses a reference to the value parameter <i class="parameter"><tt>v</tt></i>. 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"><i class="parameter"><tt>a</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>v</tt></i> :</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="id3291260"></a><h3><a name="g-array-prepend-vals"></a>g_array_prepend_vals ()</h3><a class="indexterm" name="id3291272"></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 <i class="parameter"><tt>len</tt></i> elements onto the start of the array. </p><p> This operation is slower than <a href="glib-Arrays.html#g-array-append-vals"><tt class="function">g_array_append_vals()</tt></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"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>a pointer to the elements to prepend to the start of the array. </td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</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="id3291410"></a><h3><a name="g-array-insert-val"></a>g_array_insert_val()</h3><a class="indexterm" name="id3291422"></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"><tt class="function">g_array_insert_val()</tt></a> is a macro which uses a reference to the value parameter <i class="parameter"><tt>v</tt></i>. 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"><i class="parameter"><tt>a</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>i</tt></i> :</span></td><td>the index to place the element at. </td></tr><tr><td><span class="term"><i class="parameter"><tt>v</tt></i> :</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="id3291534"></a><h3><a name="g-array-insert-vals"></a>g_array_insert_vals ()</h3><a class="indexterm" name="id3291545"></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 <i class="parameter"><tt>len</tt></i> 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"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>index_</tt></i> :</span></td><td>the index to place the elements at. </td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>a pointer to the elements to insert. </td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</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="id3291697"></a><h3><a name="g-array-remove-index"></a>g_array_remove_index ()</h3><a class="indexterm" name="id3291709"></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"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>index_</tt></i> :</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="id3291812"></a><h3><a name="g-array-remove-index-fast"></a>g_array_remove_index_fast ()</h3><a class="indexterm" name="id3291824"></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"><tt class="function">g_array_remove_index()</tt></a>. </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <i class="parameter"><tt>GArray</tt></i>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>index_</tt></i> :</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="id3291945"></a><h3><a name="g-array-remove-range"></a>g_array_remove_range ()</h3><a class="indexterm" name="id3291956"></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"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <i class="parameter"><tt>GArray</tt></i>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>index_</tt></i> :</span></td><td>the index of the first element to remove. </td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</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="id3292085"></a><h3><a name="g-array-sort"></a>g_array_sort ()</h3><a class="indexterm" name="id3292095"></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 <i class="parameter"><tt>compare_func</tt></i> which should be a <tt class="function">qsort()</tt>-style comparison function (returns -1 for first arg is less than second arg, 0 for equal, 1 if first arg is greater than second arg). </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>compare_func</tt></i> :</span></td><td>comparison function. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3292198"></a><h3><a name="g-array-sort-with-data"></a>g_array_sort_with_data ()</h3><a class="indexterm" name="id3292210"></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"><tt class="function">g_array_sort()</tt></a>, but the comparison function receives a user data argument. </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>compare_func</tt></i> :</span></td><td>comparison function. </td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td>data to pass to <i class="parameter"><tt>compare_func</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3292326"></a><h3><a name="g-array-index"></a>g_array_index()</h3><a class="indexterm" name="id3292337"></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="id3292360"></a><p class="title"><b>Example 4. 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"><i class="parameter"><tt>a</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i> :</span></td><td>the type of the elements. </td></tr><tr><td><span class="term"><i class="parameter"><tt>i</tt></i> :</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 <i class="parameter"><tt>i</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3292459"></a><h3><a name="g-array-set-size"></a>g_array_set_size ()</h3><a class="indexterm" name="id3292470"></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 <i class="parameter"><tt>clear_</tt></i> set to <tt class="literal">TRUE</tt>, 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"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</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="id3292585"></a><h3><a name="g-array-free"></a>g_array_free ()</h3><a class="indexterm" name="id3292596"></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 <i class="parameter"><tt>free_segment</tt></i> is <tt class="literal">TRUE</tt> it frees the actual element data as well. </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>array</tt></i> :</span></td><td>a <a href="glib-Arrays.html#GArray"><span class="type">GArray</span></a>. </td></tr><tr><td><span class="term"><i class="parameter"><tt>free_segment</tt></i> :</span></td><td>if <tt class="literal">TRUE</tt> 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 <i class="parameter"><tt>free_segment</tt></i> is <tt class="literal">FALSE</tt>, otherwise <tt class="literal">NULL</tt> </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="glib-String-Chunks.html"><b><< String Chunks</b></a></td><td align="right"><a accesskey="n" href="glib-Pointer-Arrays.html"><b>Pointer Arrays >></b></a></td></tr></table></body></html>