Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
ShiList.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Sushi - Lists
4 |
5 | $Id: ShiList.h 7930 2014-06-25 11:05:10Z jebaseelir $
6 | Original author: Gilles Boccon-Gibod
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2005-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _SHI_LIST_H_
22 #define _SHI_LIST_H_
23 
24 /*----------------------------------------------------------------------
25 | includes
26 +---------------------------------------------------------------------*/
27 #include "ShiResults.h"
28 #include "ShiTypes.h"
29 #include "ShiData.h"
30 
31 /*----------------------------------------------------------------------
32 | interfaces
33 +---------------------------------------------------------------------*/
34 #if defined(__cplusplus)
35 extern "C" {
36 #endif
37 
46 typedef struct SHI_Iterator SHI_Iterator;
47 
56 SHI_PUBLIC_API
57 SHI_Result
58 SHI_Iterator_Release(SHI_Iterator* self);
59 
70 SHI_PUBLIC_API
71 SHI_Result
72 SHI_Iterator_GetNext(SHI_Iterator* self, SHI_Data** item);
73 
80 typedef struct SHI_List SHI_List;
81 
90 SHI_PUBLIC_API
91 SHI_Result
92 SHI_List_Release(SHI_List* self);
93 
100 SHI_PUBLIC_API
101 SHI_Cardinal
102 SHI_List_GetItemCount(SHI_List* self);
103 
117 SHI_PUBLIC_API
118 SHI_Result
119 SHI_List_GetItem(SHI_List* self, SHI_Ordinal indx, SHI_Data** item);
120 
131 SHI_PUBLIC_API
132 SHI_Result
133 SHI_List_GetIterator(SHI_List* self, SHI_Iterator** iterator);
134 
136 #if defined (__cplusplus)
137 }
138 #endif
139 
140 #endif /* _SHI_LIST_H_ */
SHI_PUBLIC_API
#define SHI_PUBLIC_API
Definition: ShiTypes.h:52
ShiResults.h
Result codes.
SHI_Ordinal
SHI_UInt32 SHI_Ordinal
An unsigned integer that represents a position in a sequence (such as an index into a list of element...
Definition: ShiTypes.h:118
SHI_List_GetItemCount
SHI_PUBLIC_API SHI_Cardinal SHI_List_GetItemCount(SHI_List *self)
Gets the number of items in this list.
SHI_List_Release
SHI_PUBLIC_API SHI_Result SHI_List_Release(SHI_List *self)
Releases this list object.
SHI_Iterator_GetNext
SHI_PUBLIC_API SHI_Result SHI_Iterator_GetNext(SHI_Iterator *self, SHI_Data **item)
Gets the next SHI_Data object 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. ...
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.
SHI_Cardinal
SHI_UInt32 SHI_Cardinal
An unsigned integer used to represent a quantity that can be counted (such as a number of elements in...
Definition: ShiTypes.h:112
SHI_Iterator_Release
SHI_PUBLIC_API SHI_Result SHI_Iterator_Release(SHI_Iterator *self)
Releases this iterator object.
SHI_List
struct SHI_List SHI_List
Definition: ShiList.h:80
SHI_Data
struct SHI_Data SHI_Data
A SHI_Data object represents a typed data object.
Definition: EmbProcessor.h:231
ShiTypes.h
Common data types.
SHI_Result
int SHI_Result
Signed integer value representing a function or method result (return value).
Definition: ShiTypes.h:74
ShiData.h
Generic Data Objects.
SHI_Iterator
struct SHI_Iterator SHI_Iterator
A SHI_Iterator object iterates over a list of SHI_Data objects.
Definition: ShiList.h:46