DWC_GetOwnStatusString

Syntax

#include <dwc.h>

BOOL DWC_GetOwnStatusString(char *statusString);

Arguments

statusString Pointer to the storage location for the status string. Up to 255 characters plus the NULL terminator.

Return Values

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

Description

Gets status string from within the system'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. However, the status character string can be configured by the application using the DWC_SetOwnStatusString function. Refer to the Return Values section of the DWC_GetFriendStatus function for information about the status flag type.

In this function, communication does not take place to get your own Status string stored within the DWC library.

In order to use this function, you must have completed a login using the DWC_LoginAsync function.

Use the DWC_SetOwnStatusData and DWC_GetOwnStatusData functions to set or get binary data instead of a string.

Revision History


CONFIDENTIAL