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_GetFriendStatusDataSC</title> 9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13<a name="dwc__friend_8h_1e94f890276bde93d42a0f85207b625bd"></a> 14<h1 align="left">DWC_GetFriendStatusDataSC</h1> 15<h2>Syntax</h2> 16 17<dl> 18 <dd> 19<CODE>#include <dwc.h></CODE><BR> 20 <BR> 21 <PRE><CODE>u8 <a href=DWC_GetFriendStatusDataSC.html#dwc__friend_8h_1e94f890276bde93d42a0f85207b625bd>DWC_GetFriendStatusDataSC</a>(const DWCFriendData *friendData, 22 u8 *maxEntry, 23 u8 *numEntry, 24 char *statusData, 25 int *size);</CODE></PRE></dd> 26</dl> 27 28<h2>Arguments</h2> 29 30<TABLE border="1" width="100%"> 31 <TBODY> 32 33 <TR> 34<TD width="13%"><EM><STRONG>friendData</STRONG></EM></TD> 35<TD width="87%">Pointer to <CODE>DWCFriendData</CODE> type friend data.</TD> 36 </TR> 37 38 <TR> 39<TD width="13%"><EM><STRONG>maxEntry</STRONG></EM></TD> 40<TD width="87%">When the other party is the server host during server-client matchmaking, this pointer stores the maximum number of connectable devices that was obtained. Otherwise, 0.</TD> 41 </TR> 42 43 <TR> 44<TD width="13%"><EM><STRONG>numEntry</STRONG></EM></TD> 45<TD width="87%">When the other party is the server host during server-client matchmaking, this pointer stores the current number of connected devices that was obtained. Otherwise, 0.</TD> 46 </TR> 47 48 <TR> 49<TD width="13%"><EM><STRONG>statusData</STRONG></EM></TD> 50<TD width="87%">Pointer to where the friend's status data is stored. If NULL is passed, the data is not copied.</TD> 51 </TR> 52 53 <TR> 54<TD width="13%"><EM><STRONG>size</STRONG></EM></TD> 55<TD width="87%">Pointer to where the length of the friend's status data is stored. In the case of invalid data, -1 is stored.</TD> 56 </TR> 57 58 </TBODY> 59</TABLE> 60 61<h2>Return Values</h2> 62 63<TABLE border="1" width="100%"> 64 <TBODY> 65 66 <TR> 67<TD width="13%"><EM><STRONG>DWC_STATUS_OFFLINE</STRONG></EM></TD> 68<TD width="87%">Offline<BR>(Indicates that oneself is offline or that friendship with the other party has not yet been established.)</TD> 69 </TR> 70 71 <TR> 72<TD width="13%"><EM><STRONG>DWC_STATUS_ONLINE</STRONG></EM></TD> 73<TD width="87%">Online (Logged in to a Wi-Fi Connection server.)</TD> 74 </TR> 75 76 <TR> 77<TD width="13%"><EM><STRONG>DWC_STATUS_PLAYING</STRONG></EM></TD> 78<TD width="87%">Currently playing a game as a client (does not depend on matchmaking type)<br>Currently playing a game as a server, after at least one server exchange, when using friend-specified matchmaking or server-client matchmaking<br>Either of the above states indicate that the local host cannot proceed to connection with this other party. (The PLAYING state is not a state that accepts connection.)</TD> 79 </TR> 80 81 <TR> 82<TD width="13%"><EM><STRONG>DWC_STATUS_MATCH_ANYBODY</STRONG></EM></TD> 83<TD width="87%">Currently searching for a connection partner during peer matchmaking with friend unspecified<br>Currently playing a game as a server during peer matchmaking with friend unspecified</TD> 84 </TR> 85 86 <TR> 87<TD width="13%"><EM><STRONG>DWC_STATUS_MATCH_FRIEND</STRONG></EM></TD> 88<TD width="87%">Currently searching for a connection partner during peer matchmaking with friend specified<br>Currently playing a game as a server during peer matchmaking with friend specified</TD> 89 </TR> 90 91 <TR> 92<TD width="13%"><EM><STRONG>DWC_STATUS_MATCH_SC_CL</STRONG></EM></TD> 93<TD width="87%">Currently connecting to a server as a client host during server-client matchmaking<br>Currently connecting to a server as a group ID connection client host</TD> 94 </TR> 95 96 <TR> 97<TD width="13%"><EM><STRONG>DWC_STATUS_MATCH_SC_SV</STRONG></EM></TD> 98<TD width="87%">Currently playing a game as a server host during server-client matchmaking</TD> 99 </TR> 100 101 </TBODY> 102</TABLE> 103 104<H2>Description</H2> 105<p>This function gets the communication status of the friend specified with <CODE>friendData</CODE>. The GameSpy server sends a notification each time the friend's communication status changes. This is saved in the internal cache of the DWC library. Therefore, this function references that status and does not perform any communications.</p><p>A player's communication status is made up of the status flag, returned by this function, and the status character string. The player status 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. In addition to these, server host-specific information is included during server-client matchmaking. The status flag and the server-specific information are automatically set by the DWC library, but the application can set the status data by using the <A href="DWC_SetOwnStatusData.html">DWC_SetOwnStatusData</a> function. The data specified by this function is encoded in Base64 and sent to the GameSpy server as the status character string.</p><p>Use the <A href="DWC_GetFriendStatusData.html">DWC_GetFriendStatusData</a> function if there is no need to obtain any specific information during server-client matchmaking. Also, for applications where character strings (rather than binary data such as <CODE>statusData</CODE>) are set with the <a href="DWC_SetOwnStatusString.html"><CODE>DWC_SetOwnStatusString</CODE></a> function, get the binary data by using the <a href="DWC_GetFriendStatus.html"><CODE>DWC_GetFriendStatus</CODE></a> or <a href="DWC_GetFriendStatusSC.html"><CODE>DWC_GetFriendStatusSC</CODE></a> function.</p> 106 107<H2>Revision History</H2> 108<DL> 109 110<DT><para>2.0.0</DT> 111<DD>Changed the return value specification.</DD> 112 113<DT><para>1.2.1</DT> 114<DD>Deleted notes regarding execution speed.</DD> 115 116</DL> 117<hr><p>CONFIDENTIAL</p></body> 118</html> 119