DWC_SetOwnStatusData

C Specification

#include <dwc.h>

BOOL DWC_SetOwnStatusData( const char* statusData, u32 size );

Description

Sets status data (binary data) from the DS's own communications status.

The player's communication status is a product of the status flag, which displays whether the player is online or offline and the status character string. This is configured by the application and managed on the GameSpy server. In this function, the binary data specified with "statusData" (called status data) is encoded in Base64 and sent to the GameSpy server as a status string. Refer to the return value column of the DWC_GetFriendStatus function for different types of status flags.

In order to use this function, you must allow the DWC_LoginAsync function to complete through login.

The set data can be obtained from other hosts with the DWC_GetFriendStatusData function.

Use the DWC_SetOwnStatusString function when you want to set a string instead of binary data.

The set character string is cleared when the DWC_ShutdownFriendsMatch function is called.

Arguments

statusData Pointer to binary data that will be set to status data.
size Binary data size. Maximum capacity is 189 Bytes.

Return Values

TRUE Set successful
FALSE Failed to set data because not yet logged in or exceeded capacity.

See Also

DWC_GetFriendStatusData, DWC_GetFriendStatusDataSC, DWC_SetOwnStatusString, DWC_GetOwnStatusData

Revision History

12/16/2005 Added an explanation of communications status, introduction of other analogous functions, and an explanation of the status data size limit.
11/07/2005 Initial version.