DWC_SetOwnStatusString

Syntax

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

Arguments

statusString String set in the status string. Of length DWC_FRIEND_STATUS_STRING_LEN or less (including null terminators). If a longer string is specified, all characters beyond DWC_FRIEND_STATUS_STRING_LEN are truncated.

Return Values

TRUE Set successful.
FALSE Failed to set status for reasons such as not yet logged in.

Description

Sets the status string in the local host's own 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 string. This is configured by the application and managed on the GameSpy server. See Return Values for the DWC_GetFriendStatus function for the different types of status flags.

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

This set string can be obtained by other hosts using the DWC_GetFriendStatus* functions.

Do not use "/" or "\" within the status strings since the library uses these characters as delimiters. When you want to use these strings, save them as binary data using the DWC_SetOwnStatusData function.

The set string is cleared when the DWC_ShutdownFriendsMatch function is called.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL