Memory-managed wrapper type.

Construct a HashTableIter struct initialized to zero.

A convenience alias for Nothing :: Maybe HashTableIter.

Initializes a key/value pair iterator and associates it with hashTable. Modifying the hash table after calling this function invalidates the returned iterator.

C code

GHashTableIter iter;
gpointer key, value;

g_hash_table_iter_init (&iter, hash_table);
while (g_hash_table_iter_next (&iter, &key, &value))
  {
    // do something with key and value
  }

Since: 2.16

Advances iter and retrieves the key and/or value that are now pointed to as a result of this advancement. If False is returned, key and value are not set, and the iterator becomes invalid.

Since: 2.16

Removes the key/value pair currently pointed to by the iterator from its associated HashTable. Can only be called after hashTableIterNext returned True, and cannot be called more than once for the same key/value pair.

If the HashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to make sure that any dynamically allocated values are freed yourself.

It is safe to continue iterating the HashTable afterward:

C code

while (g_hash_table_iter_next (&iter, &key, &value))
  {
    if (condition)
      g_hash_table_iter_remove (&iter);
  }

Since: 2.16

Replaces the value currently pointed to by the iterator from its associated HashTable. Can only be called after hashTableIterNext returned True.

If you supplied a valueDestroyFunc when creating the HashTable, the old value is freed using that function.

Since: 2.30

Removes the key/value pair currently pointed to by the iterator from its associated HashTable, without calling the key and value destroy functions. Can only be called after hashTableIterNext returned True, and cannot be called more than once for the same key/value pair.

Since: 2.16