DWC_GetFriendStatus

Syntax

#include <dwc.h>

u8 DWC_GetFriendStatus( const DWCFriendData* friendData,
                        char* statusString );

Description

This function gets the communication status of the friend specified with friendData. The GameSpy server sends a notification every time the friend's communication status changes. This is saved in the internal cache of the DWC library. This function thus references that status and does not perform any communications.

A player's communication status is made up of the status flag returned as this function's return value and the status character string passed through the statusString argument. The player status is managed on the GameSpy server. The status flag is automatically set by the DWC library. However, the status character string can be configured by the application using the DWC_SetOwnStatusString function.

When you want to acquire specific information for server-client matchmaking, use the DWC_GetFriendStatusSC function. Also, for applications where binary data (rather than character strings such as statusString) is set with the DWC_SetOwnStatusData function, get the binary data using the DWC_GetFriendStatusData or DWC_GetFriendStatusDataSC function.

This function takes several hundred microseconds. Be aware of this fact when you need to check status several times during a short interval.

Arguments

friendData The pointer to the type DWCFriendData friend information.
statusString Pointer to the location where the friend status character string is stored.
If NULL is passed, the string is not copied.
The maximum length of the character string is 255 characters + the NULL terminator.

Return Values

DWC_STATUS_OFFLINE Offline (indicates that the DWC is offline or that friendship with the partner has not yet been established).
DWC_STATUS_ONLINE Online (logged in to a Wi-Fi Connection server).
DWC_STATUS_PLAYING In-game (after matchmaking has completed).
DWC_STATUS_MATCH_ANYBODY In connect-to-anybody peer matchmaking.
DWC_STATUS_MATCH_FRIEND In connect-to-friends peer matchmaking.
DWC_STATUS_MATCH_SC_CL Client DS undergoing server-client matchmaking.
DWC_STATUS_MATCH_SC_SV Server DS undergoing server-client matchmaking.

See Also

DWC_GetFriendStatusSC
DWC_GetFriendStatusData
DWC_GetFriendStatusDataSC
DWC_SetOwnStatusString
DWC_SetOwnStatusData

Revision History

2006/02/21 Fixed errors.
2005/12/16 Added a description about the networking states and introduced other similar functions.
2005/11/07 Revisions.
2005/07/22 Initial version.


CONFIDENTIAL