#include <IUserInfo.h>

Inheritance diagram for IUserInfo:

Public Member Functions
virtual void	SetUser (const PMString &userName, int32 userColorIndex)=0

virtual void	SetUserName (const PMString &userName)=0

virtual const PMString &	GetUserName () const =0

virtual void	SetUserColorIndex (int32 userColorIndex)=0

virtual int32	GetUserColorIndex () const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Interface for getting and setting user name and color.

Member Function Documentation

virtual int32 IUserInfo::GetUserColorIndex ( ) const

pure virtual

Gets current user color index.

virtual const PMString& IUserInfo::GetUserName ( ) const

pure virtual

Get current user name.

Returns: PMString name of the current user or "Unknown User Name" if it's never been set.

virtual void IUserInfo::SetUser	(	const PMString &	userName,
		int32	userColorIndex
	)

pure virtual

Sets user name and color.

Parameters

userName	the user name to set.
userColorIndex	the user color index to set.

virtual void IUserInfo::SetUserColorIndex ( int32 userColorIndex )

pure virtual

Sets current user color index.

Parameters

userColorIndex the color index to set.

virtual void IUserInfo::SetUserName ( const PMString & userName )

pure virtual

Sets current user name.

Parameters

userName the user name to set.