g_array_new ()

GArray *
g_array_new (gboolean zero_terminated,
             gboolean clear_,
             guint element_size);

Creates a new GArray with a reference count of 1.

g_array_sized_new ()

GArray *
g_array_sized_new (gboolean zero_terminated,
                   gboolean clear_,
                   guint element_size,
                   guint reserved_size);

Creates a new GArray with reserved_size elements preallocated and a reference count of 1. 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.

g_array_ref ()

GArray *
g_array_ref (GArray *array);

Atomically increments the reference count of array by one. This function is thread-safe and may be called from any thread.

Since: 2.22

g_array_unref ()

void
g_array_unref (GArray *array);

Atomically decrements the reference count of array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread.

Since: 2.22

g_array_get_element_size ()

guint
g_array_get_element_size (GArray *array);

Gets the size of the elements in array .

Since: 2.22

g_array_append_val()

#define             g_array_append_val(a,v)

Adds the value on to the end of the array. The array will grow in size automatically if necessary.

g_array_append_val() is a macro which uses a reference to the value parameter v . This means that you cannot use it with literal values such as "27". You must use variables.

g_array_append_vals ()

GArray *
g_array_append_vals (GArray *array,
                     gconstpointer data,
                     guint len);

Adds len elements onto the end of the array.

g_array_prepend_val()

#define             g_array_prepend_val(a,v)

Adds the value on to the start of the array. The array will grow in size automatically if necessary.

This operation is slower than g_array_append_val() since the existing elements in the array have to be moved to make space for the new element.

g_array_prepend_val() is a macro which uses a reference to the value parameter v . This means that you cannot use it with literal values such as "27". You must use variables.

g_array_prepend_vals ()

GArray *
g_array_prepend_vals (GArray *array,
                      gconstpointer data,
                      guint len);

Adds len elements onto the start of the array.

This operation is slower than g_array_append_vals() since the existing elements in the array have to be moved to make space for the new elements.

g_array_insert_val()

#define             g_array_insert_val(a,i,v)

Inserts an element into an array at the given index.

g_array_insert_val() is a macro which uses a reference to the value parameter v . This means that you cannot use it with literal values such as "27". You must use variables.

g_array_insert_vals ()

GArray *
g_array_insert_vals (GArray *array,
                     guint index_,
                     gconstpointer data,
                     guint len);

Inserts len elements into a GArray at the given index.

g_array_remove_index ()

GArray *
g_array_remove_index (GArray *array,
                      guint index_);

Removes the element at the given index from a GArray. The following elements are moved down one place.

g_array_remove_index_fast ()

GArray *
g_array_remove_index_fast (GArray *array,
                           guint index_);

Removes the element at the given index from a GArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the GArray. But it is faster than g_array_remove_index().

g_array_remove_range ()

GArray *
g_array_remove_range (GArray *array,
                      guint index_,
                      guint length);

Removes the given number of elements starting at the given index from a GArray. The following elements are moved to close the gap.

Since: 2.4

g_array_sort ()

void
g_array_sort (GArray *array,
              GCompareFunc compare_func);

Sorts a GArray using compare_func which should be a qsort()-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).

This is guaranteed to be a stable sort since version 2.32.

g_array_sort_with_data ()

void
g_array_sort_with_data (GArray *array,
                        GCompareDataFunc compare_func,
                        gpointer user_data);

Like g_array_sort(), but the comparison function receives an extra user data argument.

This is guaranteed to be a stable sort since version 2.32.

There used to be a comment here about making the sort stable by using the addresses of the elements in the comparison function. This did not actually work, so any such code should be removed.

g_array_index()

#define             g_array_index(a,t,i)

Returns the element of a GArray at the given index. The return value is cast to the given type.

This example gets a pointer to an element in a GArray:

1
2
3
4

EDayViewEvent *event;
// This gets a pointer to the 4th element in the array of
// EDayViewEvent structs.
event = &g_array_index (events, EDayViewEvent, 3);

g_array_set_size ()

GArray *
g_array_set_size (GArray *array,
                  guint length);

Sets the size of the array, expanding it if necessary. If the array was created with clear_ set to TRUE, the new elements are set to 0.

g_array_set_clear_func ()

void
g_array_set_clear_func (GArray *array,
                        GDestroyNotify clear_func);

Sets a function to clear an element of array .

The clear_func will be called when an element in the array data segment is removed and when the array is freed and data segment is deallocated as well. clear_func will be passed a pointer to the element to clear, rather than the element itself.

Note that in contrast with other uses of GDestroyNotify functions, clear_func is expected to clear the contents of the array element it is given, but not free the element itself.

Since: 2.32

g_array_free ()

gchar *
g_array_free (GArray *array,
              gboolean free_segment);

Frees the memory allocated for the GArray. If free_segment is TRUE it frees the memory block holding the elements as well and also each element if array has a element_free_func set. Pass FALSE if you want to free the GArray wrapper but preserve the underlying array for use elsewhere. If the reference count of array is greater than one, the GArray wrapper is preserved but the size of array will be set to zero.

If array elements contain dynamically-allocated memory, they should be freed separately.

This function is not thread-safe. If using a GArray from multiple threads, use only the atomic g_array_ref() and g_array_unref() functions.

struct GArray

struct GArray {
  gchar *data;
  guint len;
};

Contains the public fields of a GArray.