DWC_SetOwnStatusString

Syntax

#include <dwc.h>

BOOL DWC_SetOwnStatusString(const char *statusString);

Arguments

statusString String set in the "status" string. Up to 255 characters plus the NULL terminator.
If a string longer than this is specified, it is truncated after the 256th character.

Return Values

TRUE Set successfully.
FALSE The status was not set successfully for such reasons as not yet having logged in.

Description

Sets the status string within this 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. Refer to the Return Values section of the DWC_GetFriendStatus function for information about the status flag type.

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

The string that is set can be obtained by other hosts using the DWC_GetFriendStatusData* 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.

Strings that have been set are cleared when the DWC_ShutdownFriendsMatch function is called.

Revision History


CONFIDENTIAL