gpGetNumBuddies

GameSpy SDK

gpGetNumBuddies

This function gets the number of buddies on the local profile’s buddy list.

GPResult gpGetNumBuddies(
GPConnection * connection,
int * numBuddies );
RoutineRequired HeaderDistribution
gpGetNumBuddies<gp.h>SDKZIP

Return Value

This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.

Parameters

connection
[in] A GP connection interface.
numBuddies
[out] The number of buddies.

Remarks

This function gets the number of buddies on the local profile’s buddy list.
It may take some time to receive the total number of buddies from the server, so this function may report a number smaller than the actual total while the complete buddy list is being received. To see the status of each buddy, call gpGetBuddyStatus.
The number of buddies is only valid until a buddy is added to or deleted from the buddy list.

Section Reference: Gamespy Presence SDK