SHI_Iterator Class

A generic iterator over a collection of SHI_Data objects. More...

Typedefs
typedef struct SHI_Iterator	SHI_Iterator
	A SHI_Iterator object iterates over a list of SHI_Data objects. More...

Functions
SHI_PUBLIC_API SHI_Result	SHI_Iterator_Release (SHI_Iterator *self)
	Releases this iterator object. More...
SHI_PUBLIC_API SHI_Result	SHI_Iterator_GetNext (SHI_Iterator *self, SHI_Data **item)
	Gets the next SHI_Data object in the list. More...

Detailed Description

A generic iterator over a collection of SHI_Data objects.

Typedef Documentation

typedef struct SHI_Iterator SHI_Iterator

A SHI_Iterator object iterates over a list of SHI_Data objects.

Function Documentation

SHI_PUBLIC_API SHI_Result SHI_Iterator_GetNext	(	SHI_Iterator *	self,
		SHI_Data **	item
	)

Gets the next SHI_Data object in the list.

The SHI_Data object returned must be released before this iterator is released. Returns SHI_ERROR_NO_SUCH_ITEM if there are no more items.

Parameters

self	The SHI_Iterator from which the next object will be obtained.
item	Address of a SHI_Data pointer that will be set to refer to the next SHI_Data object in the list.

SHI_PUBLIC_API SHI_Result SHI_Iterator_Release

(

SHI_Iterator *

self

)

Releases this iterator object.

The object can no longer be used after this method returns. All objects obtained from method calls to this object must be released before this object is released.

Parameters

self	The SHI_Iterator to release.