IBHashTableIterator Class Reference

An iterator over the contents of an IBHashTable. More...

#include <ircbot/hashtable.h>

Public Member Functions
int	IBHashTableIterator_moveNext (IBHashTableIterator *self)
	Move to the next position. More...
const char *	IBHashTableIterator_key (const IBHashTableIterator *self)
	Gets the key at the current position. More...
void *	IBHashTableIterator_current (const IBHashTableIterator *self)
	Gets the object at the current position. More...
void	IBHashTableIterator_destroy (IBHashTableIterator *self)
	IBHashTableIterator destructor. More...

Detailed Description

An iterator over the contents of an IBHashTable.

Member Function Documentation

IBHashTableIterator_current()

void * IBHashTableIterator_current

(

const IBHashTableIterator *

self

)

Gets the object at the current position.

Parameters

self	the IBHashTableIterator

Returns

the current object, or NULL for the invalid position

IBHashTableIterator_destroy()

void IBHashTableIterator_destroy

(

IBHashTableIterator *

self

)

IBHashTableIterator destructor.

Parameters

self	the IBHashTableIterator

IBHashTableIterator_key()

const char * IBHashTableIterator_key

(

const IBHashTableIterator *

self

)

Gets the key at the current position.

Parameters

self	the IBHashTableIterator

Returns

the current key, or NULL for the invalid position

IBHashTableIterator_moveNext()

int IBHashTableIterator_moveNext

(

IBHashTableIterator *

self

)

Move to the next position.

If the position was invalid, move to the first position. If the position was pointing to the last entry, move to invalid position.

Parameters

self	the IBHashTableIterator

Returns

1 if the new position is a valid one, 0 otherwise

---

The documentation for this class was generated from the following file:

• ircbot/hashtable.h