DWC_GetOwnStatusData

C Specification

#include <dwc.h>

int DWC_GetOwnStatusData( char* statusData );

Description

Gets status data (binary data) from the DS'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 character string. It is managed on the GameSpy server. This function presumes the status character to be a Base-64 encoded character string and obtains the status data (the statusData argument) by decoding it. The status flag is automatically set by the DWC library, but the application can set the status data by using the DWC_SetOwnStatusData function. Refer to the return value column of the DWC_GetFriendStatus function for 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.

This function does not perform any communication to obtain the DS Status data stored in the DWC library.

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

Use the DWC_SetOwnStatusString or DWC_GetOwnStatusString function to specify or get a character string instead of a binary data.

Arguments

statusData Pointer to where the status data is stored.

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.

See Also

DWC_SetOwnStatusData, DWC_SetOwnStatusString, DWC_GetOwnStatusString, DWC_GetFriendStatusData, DWC_GetFriendStatusDataSC, DWC_LoginAsync

Revision History

12/16/2005 Added a description about communication status and an introduction to other similar functions.
11/07/2005 Initial version.