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_RequestSuspendMatchAsync</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__match_8h_155667bfa85dbc5bfbc501e56d2a4e4c3"></a>
14<h1 align="left">DWC_RequestSuspendMatchAsync</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_RequestSuspendMatchAsync.html#dwc__match_8h_155667bfa85dbc5bfbc501e56d2a4e4c3>DWC_RequestSuspendMatchAsync</a>(BOOL suspend,
22                                  <a href=DWCSuspendCallback.html#dwc__match_8h_10694b2bb1c3e5ce404274abb14295bdc>DWCSuspendCallback</a> callback,
23                                  void *data);</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>suspend</STRONG></EM></TD>
33      <TD width="87%"><CODE>TRUE</CODE>: Sets the acceptance denied state.<br><CODE>FALSE</CODE>: Sets the acceptance permitted state.</TD>
34    </TR>
35
36    <TR>
37      <TD width="13%"><EM><STRONG>callback</STRONG></EM></TD>
38      <TD width="87%"><a href=DWCSuspendCallback.html#dwc__match_8h_10694b2bb1c3e5ce404274abb14295bdc><CODE>DWCSuspendCallback</CODE></a>-type function pointer that is called upon completion of the suspend process.</TD>
39    </TR>
40
41    <TR>
42      <TD width="13%"><EM><STRONG>data</STRONG></EM></TD>
43      <TD width="87%">Arbitrary data passed to <CODE>callback</CODE>.</TD>
44    </TR>
45
46  </TBODY>
47</TABLE>
48
49<h2>Return Values</h2>
50
51<TABLE border="1" width="100%">
52  <TBODY>
53
54    <TR>
55      <TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD>
56      <TD width="87%">Successfully accepted the suspension state change request.</TD>
57    </TR>
58
59    <TR>
60      <TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
61      <TD width="87%">Was not in a state to accept suspension state change requests.</TD>
62    </TR>
63
64  </TBODY>
65</TABLE>
66
67<H2>Description</H2>
68<p>Starts the processing to change the acceptance state of new participants during matchmaking.</p><p>After this function succeeds, the suspend process will be executed within subsequent calls to the <a href=DWC_ProcessFriendsMatch.html#dwc__main_8h_1c7b64bfd61e6c336a1d382fb6d1ea2d8><CODE>DWC_ProcessFriendsMatch</CODE></a> function. Once the suspend process has finished, the function specified by <CODE>callback</CODE> will be invoked. When you use suspend processing, have all hosts call this function (<CODE>DWC_RequestSuspendMatchAsync</CODE>) at the same time. The acceptance state will not change until all of the hosts call this function.</p><p>This function will return <CODE>FALSE</CODE> when it has already been called once successfully but the suspend process has not yet completed.</p>
69
70<h2>See Also</h2>
71<p>
72
73  <CODE><A href="DWC_GetSuspendMatch.html">DWC_GetSuspendMatch</A></CODE>
74
75</p>
76
77<H2>Revision History</H2>
78<DL>
79
80<DT><para>2.0.1</DT>
81<DD>Added a statement that the acceptance state is only changed after all of the hosts call this function. </DD>
82
83<DT><para>2.0.0</DT>
84<DD>Initial addition.</DD>
85
86</DL>
87<hr><p>CONFIDENTIAL</p></body>
88</html>
89