glib/org.gtkkn.bindings.glib/HashTableIter

HashTableIter

class HashTableIter(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null) : ProxyInstance

A GHashTableIter structure represents an iterator that can be used to iterate over the elements of a #GHashTable. GHashTableIter structures are typically allocated on the stack and then initialized with g_hash_table_iter_init().

The iteration order of a #GHashTableIter over the keys/values in a hash table is not defined.

Skipped during bindings generation

parameter key: key: Out parameter is not supported

Constructors

HashTableIter

constructor()

Allocate a new HashTableIter.

constructor(scope: <Error class: unknown class>)

Allocate a new HashTableIter using the provided AutofreeScope.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

Properties

glibHashTableIterPointer

val glibHashTableIterPointer: <Error class: unknown class><<Error class: unknown class>>

handle

open override val handle: <Error class: unknown class>?

Functions

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

getHashTable

fun getHashTable(): HashTable

Returns the #GHashTable associated with @iter.

hashCode

open override fun hashCode(): Int

init

fun init(hashTable: HashTable)

Initializes a key/value pair iterator and associates it with

remove

fun remove()

Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned true, and cannot be called more than once for the same key/value pair.

replace

fun replace(value: <Error class: unknown class>? = null)

Replaces the value currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned true.

steal

fun steal()

Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable, without calling the key and value destroy functions. Can only be called after g_hash_table_iter_next() returned true, and cannot be called more than once for the same key/value pair.