DWC_GetOwnStatusData

Syntax

#include <dwc.h>
int DWC_GetOwnStatusData(char *statusData);

Arguments

statusData Pointer to the location of status data storage.

Return Values

0 or higher Size of binary data retrieved.
Negative value Failed to get data because not logged in yet or for other reasons.

Description

Gets the status data (binary data) from the local host's own current communication 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. It is managed on the GameSpy server. This function assumes that the status string is a string encoded in Base64, decodes it, and thereby gets the status data (the statusData argument). The status flag is automatically set by the DWC library. However, the application can set its own status data by using the DWC_SetOwnStatusData function. See Return Values for the DWC_GetFriendStatus function for the different types of status flags.

If you set the argument statusData to NULL, you can get just the binary data size without decoding the status data.

Because this function gets the status data of the local host, which is stored internally in the DWC library, it does not perform any communication.

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

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

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL