A SHI_List object represents an ordered list of SHI_Data objects.
More...
A SHI_List object represents an ordered list of SHI_Data objects.
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. |
Gets the number of items in this list.
- Parameters
-
- Returns
- The number of items in the list.
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. |
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. |