DWC_SetOwnStatusData

Syntax

#include <dwc.h>

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

Description

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

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

To use this function, you must complete a login using the DWC_LoginAsync function.

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

To set the data with a string instead of binary data, use the DWC_SetOwnStatusString function.

When the DWC_ShutdownFriendsMatch function is called, the set string is cleared.

Arguments

statusData Pointer to the binary data that will be set as the status data.
size Size of the binary data. Maximum capacity is 189 bytes.

Return Values

TRUE The status was set successfully.
FALSE The data was not set successfully because the user had not logged in or because the data capacity was exceeded.

See Also

DWC_GetFriendStatusData
DWC_GetFriendStatusDataSC
DWC_SetOwnStatusString
DWC_GetOwnStatusData

Revision History

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


CONFIDENTIAL