DWC_GetOwnStatusString

Syntax

#include <dwc.h>
BOOL DWC_GetOwnStatusString(char *statusString);

Arguments

statusString Pointer to a 256-character buffer to receive the status string. Consists of a maximum of DWC_FRIEND_STATUS_STRING_LEN characters (including a null terminator).

Return Values

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

Description

Gets the status string from within the local host'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 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 string can be configured by the application using the DWC_SetOwnStatusString function. See Return Values for the DWC_GetFriendStatus function for the different types of status flags.

Because this function gets the status string 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.

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

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL