Note that neither keys nor values are copied when inserted into the
#GHashTable, so they must exist for the lifetime of the #GHashTable.
This means that the use of static strings is OK, but temporary
-strings (i.e. those created in buffers and those returned by GTK widgets)
+strings (i.e. those created in buffers and those returned by GTK+ widgets)
should be copied with g_strdup() before being inserted.
</para>
<para>
<!-- ##### STRUCT GHashTable ##### -->
<para>
-The #GHashTable struct is an opaque data structure to represent a
+The <structname>GHashTable</structname> struct is an opaque data structure to represent a
<link linkend="glib-Hash-Tables">Hash Table</link>.
It should only be accessed via the following functions.
</para>
@Returns:
+<!-- ##### FUNCTION g_hash_table_new_full ##### -->
+<para>
+
+</para>
+
+@hash_func:
+@key_equal_func:
+@key_destroy_func:
+@value_destroy_func:
+@Returns:
+
+
<!-- ##### USER_FUNCTION GHashFunc ##### -->
<para>
Specifies the type of the hash function which is passed to
g_hash_table_new() when a #GHashTable is created.
</para>
<para>
-The function is passed a key and should return a guint hash value.
+The function is passed a key and should return a #guint hash value.
The functions g_direct_hash(), g_int_hash() and g_str_hash() provide
hash functions which can be used when the key is a #gpointer, #gint, and
#gchar* respectively.
<!-- ##### USER_FUNCTION GEqualFunc ##### -->
<para>
Specifies the type of a function used to test two values for
-equality. The function should return TRUE if both values are equal and
-FALSE otherwise.
+equality. The function should return %TRUE if both values are equal and
+%FALSE otherwise.
</para>
@a: a value.
@b: a value to compare with.
-@Returns: TRUE if @a = @b; FALSE otherwise.
+@Returns: %TRUE if @a = @b; %FALSE otherwise.
<!-- ##### FUNCTION g_hash_table_insert ##### -->
@value:
+<!-- ##### FUNCTION g_hash_table_replace ##### -->
+<para>
+
+</para>
+
+@hash_table:
+@key:
+@value:
+
+
<!-- ##### FUNCTION g_hash_table_size ##### -->
<para>
@user_data:
+<!-- ##### FUNCTION g_hash_table_find ##### -->
+<para>
+
+</para>
+
+@hash_table:
+@predicate:
+@user_data:
+@Returns:
+
+
<!-- ##### USER_FUNCTION GHFunc ##### -->
<para>
Specifies the type of the function passed to g_hash_table_foreach().
@Returns:
+<!-- ##### FUNCTION g_hash_table_steal ##### -->
+<para>
+
+</para>
+
+@hash_table:
+@key:
+@Returns:
+
+
<!-- ##### FUNCTION g_hash_table_foreach_remove ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION g_hash_table_foreach_steal ##### -->
+<para>
+
+</para>
+
+@hash_table:
+@func:
+@user_data:
+@Returns:
+
+
<!-- ##### USER_FUNCTION GHRFunc ##### -->
<para>
Specifies the type of the function passed to g_hash_table_foreach_remove().
It is called with each key/value pair, together with the @user_data parameter
passed to g_hash_table_foreach_remove().
-It should return TRUE if the key/value pair should be removed from the
+It should return %TRUE if the key/value pair should be removed from the
#GHashTable.
</para>
@key: a key.
@value: the value associated with the key.
@user_data: user data passed to g_hash_table_remove().
-@Returns: TRUE if the key/value pair should be removed from the #GHashTable.
+@Returns: %TRUE if the key/value pair should be removed from the #GHashTable.
<!-- ##### MACRO g_hash_table_freeze ##### -->
release of GLib. It does nothing.
</para>
-@hash_table:
+@hash_table: a #GHashTable
<!-- ##### MACRO g_hash_table_thaw ##### -->
release of GLib. It does nothing.
</para>
-@hash_table:
+@hash_table: a #GHashTable
<!-- ##### FUNCTION g_hash_table_destroy ##### -->
<!-- ##### FUNCTION g_direct_equal ##### -->
<para>
-Compares two #gpointer arguments and returns TRUE if they are equal.
+Compares two #gpointer arguments and returns %TRUE if they are equal.
It can be passed to g_hash_table_new() as the @key_equal_func
parameter, when using pointers as keys in a #GHashTable.
</para>
@v: a key.
@v2: a key to compare with @v.
-@Returns: TRUE if the two keys match.
+@Returns: %TRUE if the two keys match.
<!-- ##### FUNCTION g_direct_hash ##### -->
<para>
Converts a gpointer to a hash value.
It can be passed to g_hash_table_new() as the @hash_func parameter, when
-using gpointer values as keys in a #GHashTable.
+using pointers as keys in a #GHashTable.
</para>
@v: a gpointer key.
<!-- ##### FUNCTION g_int_equal ##### -->
<para>
-Compares the two #gint values being pointed to and returns TRUE if they are
+Compares the two #gint values being pointed to and returns %TRUE if they are
equal.
It can be passed to g_hash_table_new() as the @key_equal_func
parameter, when using pointers to integers as keys in a #GHashTable.
@v: a pointer to a #gint key.
@v2: a pointer to a #gint key to compare with @v.
-@Returns: TRUE if the two keys match.
+@Returns: %TRUE if the two keys match.
<!-- ##### FUNCTION g_int_hash ##### -->
<para>
Converts a pointer to a #gint to a hash value.
It can be passed to g_hash_table_new() as the @hash_func parameter, when
-using pointers to gint values as keys in a #GHashTable.
+using pointers to integers values as keys in a #GHashTable.
</para>
@v: a pointer to a #gint key.
<!-- ##### FUNCTION g_str_equal ##### -->
<para>
-Compares two strings and returns TRUE if they are equal.
+Compares two strings and returns %TRUE if they are equal.
It can be passed to g_hash_table_new() as the @key_equal_func
parameter, when using strings as keys in a #GHashTable.
</para>
@v: a key.
@v2: a key to compare with @v.
-@Returns: TRUE if the two keys match.
+@Returns: %TRUE if the two keys match.
<!-- ##### FUNCTION g_str_hash ##### -->
projects / platform / upstream / glib.git / blobdiff