DWCFriendStatusCallback

C Specification

#include <dwc.h>

typedef void (*DWCFriendStatusCallback)(
                               int index,
                               u8  status,
                               const char* statusString,
                               void* param);

Description

This is called when a friend's communications status changes.

The player's communication status is a product of the status flag displayed by "status" and the status character string displayed by the argument statusString. It is managed on the GameSpy server. The status flag is automatically set by the DWC library, but the status character string can be configured by the application using the DWC_SetOwnStatusString or DWC_SetOwnStatusData function.

This callback function can be set using DWC_SetBuddyFriendCallback.

Arguments

index Friend roster index of the friend whose status has changed.
status Friend status. DWC_STATUS_* enumerator.
statusString Friend's status string. The maximum length of the character string is 255 characters + NULL (NULL-terminated).
param Parameter for the callback specified by DWC_UpdateServersAsync.

status can take any of the following values.

DWC_STATUS_OFFLINE Offline (Indicates the DWC is offline or that the friendship with the partner is not 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

Return Values

None.

See Also

DWC_UpdateServersAsync, DWC_SetOwnStatusString, DWC_SetOwnStatusData

Revision History

12/16/2005 Added a description of the communications status and the callback select function.
11/01/2005 Initial version