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_GetOwnStatusData</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__friend_8h_196bd7d16e4968e2b45a4892e1c6817f6"></a>
14<h1 align="left">DWC_GetOwnStatusData</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE>int <a href=DWC_GetOwnStatusData.html#dwc__friend_8h_196bd7d16e4968e2b45a4892e1c6817f6>DWC_GetOwnStatusData</a>(char *statusData);</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>statusData</STRONG></EM></TD>
31<TD width="87%">Pointer to where the status data is stored.</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>0 or higher</STRONG></EM></TD>
44<TD width="87%">Size of binary data retrieved.</TD>
45    </TR>
46
47    <TR>
48<TD width="13%"><EM><STRONG>Negative value</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 data (binary data) from the system's own current communication status.</p><p>The player's communication status is a product of the status flag, which displays whether the player is online or offline, and the status character string. It is managed on the GameSpy server. This function presumes that the status string is a character string encoded in Base64. The function obtains the status data (the <CODE>statusData</CODE> argument) by decoding the status string. The status flag is automatically set by the DWC library. However, the application can set the status data by using the <a href="DWC_SetOwnStatusData.html"><CODE>DWC_SetOwnStatusData</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>If you set the argument <CODE>statusData</CODE> to NULL, you can get just the binary data size without decoding the status data.</p><p>This function does not perform any communication to obtain the system's status data stored in 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_SetOwnStatusString.html"><CODE>DWC_SetOwnStatusString</CODE></a> or <A href="DWC_GetOwnStatusString.html"><CODE>DWC_GetOwnStatusString</CODE></a> function to set or get a character string instead of binary data.</p>
57
58<H2>Revision History</H2>
59<DL>
60
61</DL>
62<hr><p>CONFIDENTIAL</p></body>
63</html>
64