1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
8<title>DWC_GetOwnStatusString</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__friend_8h_102c7ea3da0c73733bbdfdc14e3085ca5"></a>
14<h1 align="left">DWC_GetOwnStatusString</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE>BOOL <a href=DWC_GetOwnStatusString.html#dwc__friend_8h_102c7ea3da0c73733bbdfdc14e3085ca5>DWC_GetOwnStatusString</a>(char *statusString);</CODE></PRE></dd>
22</dl>
23
24<h2>Arguments</h2>
25
26<TABLE border="1" width="100%">
27  <TBODY>
28
29    <TR>
30<TD width="13%"><EM><STRONG>statusString</STRONG></EM></TD>
31<TD width="87%">Pointer to the storage location for the status string. Up to 255 characters plus the NULL terminator.</TD>
32    </TR>
33
34  </TBODY>
35</TABLE>
36
37<h2>Return Values</h2>
38
39<TABLE border="1" width="100%">
40  <TBODY>
41
42    <TR>
43<TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD>
44<TD width="87%">Acquisition successful.</TD>
45    </TR>
46
47    <TR>
48<TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
49<TD width="87%">Failed to get data because not logged in yet or for some other reason.</TD>
50    </TR>
51
52  </TBODY>
53</TABLE>
54
55<H2>Description</H2>
56<p>Gets status string from within the system's own current communication status.</p><p>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 <CODE>statusString</CODE>. 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 <a href="DWC_SetOwnStatusString.html"><CODE>DWC_SetOwnStatusString</CODE></a> function. Refer to the Return Values section of the <a href="DWC_GetFriendStatus.html"><CODE>DWC_GetFriendStatus</CODE></a> function for information about the status flag type.</p><p>In this function, communication does not take place to get your own Status string stored within the DWC library.</p><p>In order to use this function, you must have completed a login using the <A href="DWC_LoginAsync.html"><CODE>DWC_LoginAsync</CODE></A> function.</p><p>Use the <a href="DWC_SetOwnStatusData.html"><CODE>DWC_SetOwnStatusData</CODE></a> and <a href="DWC_GetOwnStatusData.html"><CODE>DWC_GetOwnStatusData</CODE></a>  functions to set or get binary data instead of a string.</p>
57
58<H2>Revision History</H2>
59<DL>
60
61</DL>
62<hr><p>CONFIDENTIAL</p></body>
63</html>
64