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_GetMatchStringValue</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__match_8h_1d02811d6603b29dc1b7cd6aa75bec05a"></a>
14<h1 align="left">DWC_GetMatchStringValue</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE>const char* <a href=DWC_GetMatchStringValue.html#dwc__match_8h_1d02811d6603b29dc1b7cd6aa75bec05a>DWC_GetMatchStringValue</a>(int index,
22                                    const char *keyString,
23                                    const char *sdefault);</CODE></PRE></dd>
24</dl>
25
26<h2>Arguments</h2>
27
28<TABLE border="1" width="100%">
29  <TBODY>
30
31    <TR>
32<TD width="13%"><EM><STRONG>index</STRONG></EM></TD>
33<TD width="87%">Index of matchmaking candidate players. The <CODE>index</CODE> argument of the evaluation callback is passed unchanged.</TD>
34    </TR>
35
36    <TR>
37<TD width="13%"><EM><STRONG>keyString</STRONG></EM></TD>
38<TD width="87%">Pointer to the character string for identifying the key.</TD>
39    </TR>
40
41    <TR>
42<TD width="13%"><EM><STRONG>sdefault</STRONG></EM></TD>
43<TD width="87%">The default character string for players who do not have a specified key. <br>Note: This default value will also be returned if an empty string corresponds to the key or if communications with the server are under way.</TD>
44    </TR>
45
46  </TBODY>
47</TABLE>
48
49<h2>Return Values</h2>
50
51<p>The character string corresponding to the specified key held by the matchmaking candidate player. If they have no key, the string passed to the <CODE>sdefault</CODE> argument is returned.</p>
52
53<H2>Description</H2>
54<p>This function returns a text string that corresponds to the matchmaking condition key.</p><p>This function is guaranteed only for use inside the player evaluation callback. The returned value is undefined if the function is called from outside of the callback.</p><p>The default value will be returned if an empty string was specified with the <a href=DWC_AddMatchKeyString.html#dwc__match_8h_1a6dc592558f9f69faff4f1911782f3a8><CODE>DWC_AddMatchKeyString</CODE></a> function or if the requested value has not yet been returned by the server.</p><p>It takes some time for the addition of a condition key to be propagated to the server. Thus, even if the application sets the condition key, it will sometimes be determined to not exist, and the default value will be returned.</p>
55
56<H2>Revision History</H2>
57<DL>
58
59<DT><para>1.4.20</DT>
60<DD>Noted that it takes some time for the addition of a condition key to be propagated to the server.</DD>
61
62<DT><para>1.4.20</DT>
63<DD>Noted that empty strings cannot be specified.</DD>
64
65</DL>
66<hr><p>CONFIDENTIAL</p></body>
67</html>
68