DWC_GetOwnStatusData

Syntax

#include <dwc.h>

int DWC_GetOwnStatusData( char* statusData );

Description

Gets status (binary) data from the system'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 assumes that status is a character string encoded in Base64. The function obtains the status data (the statusData argument) by decoding status. The status flag is automatically set by the DWC library. However, the application can set the status data by using the DWC_SetOwnStatusData function. For the status flag type, refer to the return value column of the DWC_GetFriendStatus function.

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 system's status data stored in the DWC library.

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

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

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 some other reason.

See Also

DWC_SetOwnStatusData
DWC_SetOwnStatusString
DWC_GetOwnStatusString
DWC_GetFriendStatusData
DWC_GetFriendStatusDataSC
DWC_LoginAsync

Revision History

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


CONFIDENTIAL