DWC_SetOwnStatusData

Syntax

#include <dwc.h>
BOOL DWC_SetOwnStatusData(const char *statusData,
                          u32 size);

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 Set successful.
FALSE Not set successfully because the user had not logged in or because the data capacity was exceeded.

Description

Sets the status data in the local host'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 string. 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. See Return Values for the DWC_GetFriendStatus function for the different types of status flags.

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* functions.

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

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

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL