ICELib  1
Public Member Functions | Related Functions
iceUserList Class Reference

A container of users. More...

List of all members.

Public Member Functions

IceCoreResult iceUserListClear (iceUserList *pList)
 Clear the store of all users.

Related Functions

(Note that these are not member 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.

Detailed Description

A container of users.

 All Classes Functions