DWC_SetOwnStatusString

C Specification

#include <dwc.h>

BOOL DWC_SetOwnStatusString(const char* statusString);

Description

Sets the status string within the DS'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 value column of the DWC_GetFriendStatus function for different types of status flags.

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

This set string can be obtained by other hosts using the DWC_GetFriendStatusData* function.

Do not use / or \\ within the status string, because the library uses them 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.

Arguments

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

Return Values

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

See Also

DWC_GetFriendStatus, DWC_GetFriendStatusSC, DWC_SetOwnStatusData, DWC_GetOwnStatusString

Revision History

12/16/2005 Added the description regarding the communication status.
11/07/2005 Initial version.