DWC_GetFriendStatus

Syntax

#include <dwc.h>
u8 DWC_GetFriendStatus(const DWCFriendData *friendData,
                       char *statusString);

Arguments

friendData Pointer to DWCFriendData type friend information.
statusString Pointer to the location where the friend's status string is stored.
If NULL is passed, the string is not copied.
The string consists of a maximum of DWC_FRIEND_STATUS_STRING_LEN characters (including a null terminator).

Return Values

DWC_STATUS_OFFLINE Offline
(indicates that the local host is offline or that friendship with the other party has not been established).
DWC_STATUS_ONLINE Online (logged in to a Wi-Fi Connection server).
DWC_STATUS_PLAYING - Currently playing a game as a client (does not depend on matchmaking type)
- Currently playing a game as a server, after at least one instance of server migration, when using friend-specified matchmaking or server-client matchmaking
Either of the above states indicate that the local host cannot proceed to connection with this other party. (The PLAYING state is not a state that accepts connection.)
DWC_STATUS_MATCH_ANYBODY - Currently searching for a connection partner during peer matchmaking with friend unspecified
- Currently playing a game as a server during peer matchmaking with friend unspecified
DWC_STATUS_MATCH_FRIEND - Currently searching for a connection partner during peer matchmaking with friend specified
- Currently playing a game as a server during peer matchmaking with friend specified
DWC_STATUS_MATCH_SC_CL - Currently connecting to a server as a client host during server-client matchmaking
- Currently connecting to a server as a group ID connection client host
DWC_STATUS_MATCH_SC_SV - Currently playing a game as a server host during server-client matchmaking

Description

Gets the communication status of the friend specified with friendData. The GameSpy server sends a notification each time the friend's communication status changes, which is saved in the internal cache of the DWC library. Therefore, this function 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 string passed with the statusString argument. The player status is managed on the GameSpy server. The status flag is automatically set by the DWC library, but the status string can be configured by the application using the DWC_SetOwnStatusString function.

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

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL