PSC_HashTableIterator Class Reference

An iterator over the contents of a PSC_HashTable. More...

#include <poser/core/hashtable.h>

Public Member Functions
int	PSC_HashTableIterator_moveNext (PSC_HashTableIterator *self)
	Move to the next position.
const char *	PSC_HashTableIterator_key (const PSC_HashTableIterator *self)
	Gets the key at the current position.
void *	PSC_HashTableIterator_current (const PSC_HashTableIterator *self)
	Gets the object at the current position.
void	PSC_HashTableIterator_destroy (PSC_HashTableIterator *self)
	PSC_HashTableIterator destructor.

Detailed Description

An iterator over the contents of a PSC_HashTable.

Member Function Documentation

PSC_HashTableIterator_current()

void * PSC_HashTableIterator_current

(

const PSC_HashTableIterator *

self

)

Gets the object at the current position.

Parameters

self	the PSC_HashTableIterator

Returns

the current object, or NULL for the invalid position

PSC_HashTableIterator_destroy()

void PSC_HashTableIterator_destroy

(

PSC_HashTableIterator *

self

)

PSC_HashTableIterator destructor.

Parameters

self	the PSC_HashTableIterator

PSC_HashTableIterator_key()

const char * PSC_HashTableIterator_key

(

const PSC_HashTableIterator *

self

)

Gets the key at the current position.

Parameters

self	the PSC_HashTableIterator

Returns

the current key, or NULL for the invalid position

PSC_HashTableIterator_moveNext()

int PSC_HashTableIterator_moveNext

(

PSC_HashTableIterator *

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 PSC_HashTableIterator

Returns

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

---

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

• poser/core/hashtable.h