ICELib  1
Classes | Functions
iceUserList
ICECore - IndieCity Extras integration interfaces

a container of users More...

Classes

class  iceUserList
 A container of users. More...

Functions

iceUserListiceUserListCreate ()
 create a empty UserList object
int iceUserListAddReference (iceUserList *pList)
 create a empty UserList object
int iceUserListRelease (iceUserList *pList)
 create a empty UserList object
IceCoreResult iceUserListLoad (iceUserList *pList, const char *filename, const char *key)
 load the contents of the user list from a file
IceCoreResult iceUserListSave (const iceUserList *pList, const char *filename, const char *key)
 Write the contents of the userstore to a file.
unsigned int iceUserListGetUserCount (const iceUserList *pList)
 Get the number of users in the store.
bool iceUserListIsEmpty (const iceUserList *pList)
 returns true if the userstore is empty
iceUserInfoiceUserListGetUserFromIndex (const iceUserList *pList, unsigned int userIndex)
 Get a IUserInfo interface to the user at the given zero based index in the list.
iceUserInfoiceUserListGetUserFromId (const iceUserList *pList, iceUserId userId)
 Get an IUserInfo interface for the user with the given user id.
IceCoreResult iceUserListAddUser (iceUserList *pList, iceUserInfo *pUserInfo)
 Add a user to the store.
IceCoreResult iceUserListRemoveUserAtIndex (iceUserList *pList, unsigned int userIndex)
 Remove the user at the given index in the store.
IceCoreResult iceUserListRemoveUserWithId (iceUserList *pList, iceUserId userId)
 Remove the user with given id from the store.
IceCoreResult iceUserList::iceUserListClear (iceUserList *pList)
 Clear the store of all users.

Detailed Description

a container of users


Function Documentation

int iceUserListAddReference ( iceUserList pList) [related]

create a empty UserList object

Parameters:
[in]pListpointer to user list object
IceCoreResult iceUserListAddUser ( iceUserList pList,
iceUserInfo pUserInfo 
) [related]

Add a user to the store.

Parameters:
[in]pListpointer to user list object
[in]pUserInfopointer to a user object to add to list
Returns:
IceCoreResult iceUserListClear ( iceUserList pList)

Clear the store of all users.

Parameters:
[in]pListpointer to user list object
Returns:
iceUserList * iceUserListCreate ( ) [related]

create a empty UserList object

Use iceUserListRelease to delete the object

Returns:
unsigned int iceUserListGetUserCount ( const iceUserList pList) [related]

Get the number of users in the store.

Parameters:
[in]pListpointer to user list object
Returns:
the user count
iceUserInfo * iceUserListGetUserFromId ( const iceUserList pList,
iceUserId  userId 
) [related]

Get an IUserInfo interface for the user with the given user id.

Parameters:
[in]pListpointer to user list object
[in]userId
Returns:
iceUserInfo * iceUserListGetUserFromIndex ( const iceUserList pList,
unsigned int  userIndex 
) [related]

Get a IUserInfo interface to the user at the given zero based index in the list.

Parameters:
[in]pListpointer to user list object
[in]userIndex
Returns:
bool iceUserListIsEmpty ( const iceUserList pList) [related]

returns true if the userstore is empty

Parameters:
[in]pListpointer to user list object
Returns:
true if the userstore is empty, false otherwise
IceCoreResult iceUserListLoad ( iceUserList pList,
const char *  filename,
const char *  key 
) [related]

load the contents of the user list from a file

Parameters:
[in]pListpointer to user list object
filename
keyencryption string
Returns:
int iceUserListRelease ( iceUserList pList) [related]

create a empty UserList object

Parameters:
[in]pListpointer to user list object
IceCoreResult iceUserListRemoveUserAtIndex ( iceUserList pList,
unsigned int  userIndex 
) [related]

Remove the user at the given index in the store.

Parameters:
[in]pListpointer to user list object
[in]userIndexzero based index of user in list to remove
Returns:
IceCoreResult iceUserListRemoveUserWithId ( iceUserList pList,
iceUserId  userId 
) [related]

Remove the user with given id from the store.

Parameters:
[in]pListpointer to user list object
[in]userIdid of user to remove from list
Returns:
IceCoreResult iceUserListSave ( const iceUserList pList,
const char *  filename,
const char *  key 
) [related]

Write the contents of the userstore to a file.

Parameters:
[in]pListpointer to user list object
[in]filename
[in]keyencryption string used to encrypt the file
Returns:
 All Classes Functions