a container of users More...

Classes
class	iceUserInfo
	stores user properties More...
Reference Counting
int	iceUserInfoAddRef (iceUserInfo *pUserInfo)
	increment the ref count
int	iceUserInfoRelease (iceUserInfo *pUserInfo)
	indicate that the userinfo object has been finished with;
Properties
IceCoreResult	iceUserInfoGetName (const iceUserInfo pUserInfo, char buffer, size_t maxBufferSize, size_t *pNameLength=NULL)
	Obtain name in utf8 format.
iceUserId	iceUserInfoGetId (const iceUserInfo *pUserInfo)
	Get the IndieCity user id.

Detailed Description

a container of users

Function Documentation

int iceUserInfoAddRef ( iceUserInfo * pUserInfo ) [related]

increment the ref count

Parameters:

[in] pUserInfo pointer to userinfo object

iceUserId iceUserInfoGetId ( const iceUserInfo * pUserInfo ) [related]

Get the IndieCity user id.

Parameters:

[in] pUserInfo pointer to userinfo object

IceCoreResult iceUserInfoGetName	(	const iceUserInfo *	pUserInfo,
		char *	buffer,
		size_t	maxBufferSize,
		size_t *	pNameLength = `NULL`
	)		`[related]`

Obtain name in utf8 format.

Parameters:

[in]	pUserInfo	pointer to userinfo object
[in]	buffer	to write name to
[in]	maxBufferSize	maximum num of chars that can be writting including space for nul terminator. The maximum name length is currently 15 unicode characters. A utf8 buffer might have to be 6 times this to contain exotic symbols.
[out]	pNameLength	pointer to variable to write how many characters were written.

int iceUserInfoRelease ( iceUserInfo * pUserInfo ) [related]

indicate that the userinfo object has been finished with;

Parameters:

[in] pUserInfo pointer to userinfo object