DWC_GetOwnStatusString

C Specification

#include <dwc.h>

BOOL DWC_GetOwnStatusString( char* statusString );

Description

Gets status string from within the DS's own current communication status.

The player's communication status is a product of the status flag, which indicates whether the player is online or offline, and the status character string displayed by the argument statusString. It is managed on the GameSpy server. The status flag is automatically set by the DWC library, but the status character string can be configured by the application using the DWC_SetOwnStatusString function. Refer to the return value section of the DWC_GetFriendStatus function for different types of status flags.

In this function, communications are not performed to get your own Status string stored within the DWC library.

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

Use the DWC_SetOwnStatusData and DWC_GetOwnStatusData functions when you want to specify or get binary data instead of a string.

Arguments

statusString Pointer to a 256-character buffer to receive the status string. Up to 255 characters plus NULL terminator.

Return Values

TRUE Acquisition successful.
FALSE Failed to get data because not logged in yet or for other reasons.

See Also

DWC_SetOwnStatusString, DWC_SetOwnStatusData, DWC_GetOwnStatusData, DWC_GetFriendStatus, DWC_GetFriendStatusSC, 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.