IAccGroup Interface Reference

---

Detailed Description

The IAccGroup interface represents a group of buddies.

Public Types

• enum AccGroupProp {
    AccGroupProp_Session = -1,
    AccGroupProp_Name,
    AccGroupProp_OnlineCount,
    AccGroupProp_Collapsed,
    AccGroupProp_Shared,
    AccGroupProp_RecentBuddies,
    AccGroupProp_Smart,
    AccGroupProp_ReadOnly,
    AccGroupProp_SynchronizedStorageType,
    AccGroupProp_SynchronizedStorageName,
    AccGroupProp_Offline
  }
• typedef enum
  IAccGroup::AccGroupProp AccGroupProp

Public Member Functions

• HRESULT Name ([out, retval] xp_str *name)
• HRESULT Name ([in] xp_kstr name)
• HRESULT Property ([in] AccGroupProp property,[out, retval] xp_variant *value)
• HRESULT Property ([in] AccGroupProp property,[in] xp_kvariant value)
• HRESULT BuddyCount ([out, retval] xp_int *count)
• HRESULT GetBuddyByIndex ([in] xp_int position,[out, retval] IAccUser **user)
• HRESULT GetBuddyPosition ([in] IAccUser *user,[out, retval] xp_int *position)
• HRESULT InsertBuddy ([in] xp_kvariant user,[in, defaultvalue(-1)] xp_int position,[out, retval, defaultvalue(0)] IAccUser **userRetval)
• HRESULT RemoveBuddy ([in] xp_int position)
• HRESULT MoveBuddy ([in] xp_int fromPosition,[in] xp_int toPosition)
• HRESULT GetBuddyByName ([in] xp_kstr name,[out, retval] IAccUser **user)

---

Member Typedef Documentation

typedef enum IAccGroup::AccGroupProp IAccGroup::AccGroupProp

Properties for the Property method.

---

Member Enumeration Documentation

enum IAccGroup::AccGroupProp

Properties for the Property method.

Enumerator:

AccGroupProp_Session	The IAccSession associated with the IAccGroup [get] IAccSession**
AccGroupProp_Name	The name of the group [get] xp_str* [put] xp_kstr
AccGroupProp_OnlineCount	The number of online buddies in the group [get] xp_s32*
AccGroupProp_Collapsed	Whether the group is collapsed [get] xp_bool* [put] bool
AccGroupProp_Shared	Whether the group is "shared" [get] xp_bool*
AccGroupProp_RecentBuddies	Whether the group is the "recent buddies" group [get] xp_bool*
AccGroupProp_Smart	Whether the group is a smart group [get] xp_bool*
AccGroupProp_ReadOnly	Whether the group is read-only [get] xp_bool*
AccGroupProp_SynchronizedStorageType	If synched with a database, the storage type [get] xp_str* [put] xp_kstr
AccGroupProp_SynchronizedStorageName	If synched with a database, the storage name [get] xp_str* [put] xp_kstr
AccGroupProp_Offline	Whether the group is the offline buddies group [get] xp_bool*

---

Member Function Documentation

HRESULT IAccGroup::Name

(

[out, retval] xp_str *

name

)

[get]

Gets the name of the group.

HRESULT IAccGroup::Name

(

[in] xp_kstr

name

)

[set]

Sets the name of the group.

HRESULT IAccGroup::Property	(	[in] AccGroupProp	property,
		[out, retval] xp_variant *	value
	)			[get]

Get a specific property of the group.

HRESULT IAccGroup::Property	(	[in] AccGroupProp	property,
		[in] xp_kvariant	value
	)			[set]

Set a specific property of the group.

HRESULT IAccGroup::BuddyCount

(

[out, retval] xp_int *

count

)

[get]

Gets the number of users in the group.

HRESULT IAccGroup::GetBuddyByIndex	(	[in] xp_int	position,
		[out, retval] IAccUser **	user
	)

Retrieves a specific user by position in the group.

HRESULT IAccGroup::GetBuddyPosition	(	[in] IAccUser *	user,
		[out, retval] xp_int *	position
	)

Get the user position given a user object.

HRESULT IAccGroup::InsertBuddy	(	[in] xp_kvariant	user,
		[in, defaultvalue(-1)] xp_int	position,
		[out, retval, defaultvalue(0)] IAccUser **	userRetval
	)

Inserts a new user in the group. Specify -1 for position to add to the end of the group.

HRESULT IAccGroup::RemoveBuddy

(

[in] xp_int

position

)

Removes a user from the group.

HRESULT IAccGroup::MoveBuddy	(	[in] xp_int	fromPosition,
		[in] xp_int	toPosition
	)

Move user from one position in the group to another position.

HRESULT IAccGroup::GetBuddyByName	(	[in] xp_kstr	name,
		[out, retval] IAccUser **	user
	)

Finds a user by name in the group.