ICELib
1
|
a container of users More...
Classes | |
class | iceUserList |
A container of users. More... | |
Functions | |
iceUserList * | iceUserListCreate () |
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 | |
iceUserInfo * | iceUserListGetUserFromIndex (const iceUserList *pList, unsigned int userIndex) |
Get a IUserInfo interface to the user at the given zero based index in the list. | |
iceUserInfo * | iceUserListGetUserFromId (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. |
a container of users
int iceUserListAddReference | ( | iceUserList * | pList | ) | [related] |
create a empty UserList object
[in] | pList | pointer to user list object |
IceCoreResult iceUserListAddUser | ( | iceUserList * | pList, |
iceUserInfo * | pUserInfo | ||
) | [related] |
Add a user to the store.
[in] | pList | pointer to user list object |
[in] | pUserInfo | pointer to a user object to add to list |
IceCoreResult iceUserListClear | ( | iceUserList * | pList | ) |
Clear the store of all users.
[in] | pList | pointer to user list object |
iceUserList * iceUserListCreate | ( | ) | [related] |
create a empty UserList object
Use iceUserListRelease to delete the object
unsigned int iceUserListGetUserCount | ( | const iceUserList * | pList | ) | [related] |
Get the number of users in the store.
[in] | pList | pointer to user list object |
iceUserInfo * iceUserListGetUserFromId | ( | const iceUserList * | pList, |
iceUserId | userId | ||
) | [related] |
Get an IUserInfo interface for the user with the given user id.
[in] | pList | pointer to user list object |
[in] | userId |
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.
[in] | pList | pointer to user list object |
[in] | userIndex |
bool iceUserListIsEmpty | ( | const iceUserList * | pList | ) | [related] |
returns true if the userstore is empty
[in] | pList | pointer to user list object |
IceCoreResult iceUserListLoad | ( | iceUserList * | pList, |
const char * | filename, | ||
const char * | key | ||
) | [related] |
load the contents of the user list from a file
[in] | pList | pointer to user list object |
filename | ||
key | encryption string |
int iceUserListRelease | ( | iceUserList * | pList | ) | [related] |
create a empty UserList object
[in] | pList | pointer to user list object |
IceCoreResult iceUserListRemoveUserAtIndex | ( | iceUserList * | pList, |
unsigned int | userIndex | ||
) | [related] |
Remove the user at the given index in the store.
[in] | pList | pointer to user list object |
[in] | userIndex | zero based index of user in list to remove |
IceCoreResult iceUserListRemoveUserWithId | ( | iceUserList * | pList, |
iceUserId | userId | ||
) | [related] |
Remove the user with given id from the store.
[in] | pList | pointer to user list object |
[in] | userId | id of user to remove from list |
IceCoreResult iceUserListSave | ( | const iceUserList * | pList, |
const char * | filename, | ||
const char * | key | ||
) | [related] |
Write the contents of the userstore to a file.
[in] | pList | pointer to user list object |
[in] | filename | |
[in] | key | encryption string used to encrypt the file |