SHI_List Class

A SHI_List object represents an ordered list of SHI_Data objects. More...

Typedefs
typedef struct SHI_List	SHI_List

Functions
SHI_PUBLIC_API SHI_Result	SHI_List_Release (SHI_List *self)
	Releases this list object. More...
SHI_PUBLIC_API SHI_Cardinal	SHI_List_GetItemCount (SHI_List *self)
	Gets the number of items in this list. More...
SHI_PUBLIC_API SHI_Result	SHI_List_GetItem (SHI_List *self, SHI_Ordinal indx, SHI_Data **item)
	Gets an item of this list by index. More...
SHI_PUBLIC_API SHI_Result	SHI_List_GetIterator (SHI_List *self, SHI_Iterator **iterator)
	Gets a SHI_Iterator object that can be used to access all the items in this list. More...

Detailed Description

A SHI_List object represents an ordered list of SHI_Data objects.

Typedef Documentation

SHI_List

typedef struct SHI_List SHI_List

Function Documentation

SHI_List_GetItem()

SHI_PUBLIC_API SHI_Result SHI_List_GetItem	(	SHI_List *	self,
		SHI_Ordinal	indx,
		SHI_Data **	item
	)

Gets an item of this list by index.

The SHI_Data object returned must be released before this list is released. Returns SHI_ERROR_NO_SUCH_ITEM if the index is greater than or equal to the number of items in the list.

Parameters

self	The SHI_List from which an item will be returned.
indx	The index of the item. (Note: The first item of a list is at index 0.)
item	Address of a SHI_Data pointer that will be set to refer to the SHI_Data item at the specified index.

SHI_List_GetItemCount()

SHI_PUBLIC_API SHI_Cardinal SHI_List_GetItemCount

(

SHI_List *

self

)

Gets the number of items in this list.

Parameters

self	The SHI_List.

Returns

The number of items in the list.

SHI_List_GetIterator()

SHI_PUBLIC_API SHI_Result SHI_List_GetIterator	(	SHI_List *	self,
		SHI_Iterator **	iterator
	)

Gets a SHI_Iterator object that can be used to access all the items in this list.

The SHI_Iterator object returned must be released before this list is released.

Parameters

self	The SHI_List for which an iterator will be returned.
iterator	Address of a SHI_Iterator pointer that will be set to refer to the SHI_Iterator.

SHI_List_Release()

SHI_PUBLIC_API SHI_Result SHI_List_Release

(

SHI_List *

self

)

Releases this list 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_List to release.