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_CancelMatch</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__match_8h_1faf7d9109707e16447c97516666f55c8"></a>
14<h1 align="left">DWC_CancelMatch</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_CancelMatch.html#dwc__match_8h_1faf7d9109707e16447c97516666f55c8>DWC_CancelMatch</a>(void);</CODE></PRE></dd>
22</dl>
23
24<h2>Arguments</h2>
25
26<p>None.</p>
27
28<h2>Return Values</h2>
29
30<TABLE border="1" width="100%">
31  <TBODY>
32
33    <TR>
34      <TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD>
35      <TD width="87%">The cancel process succeeded.</TD>
36    </TR>
37
38    <TR>
39      <TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
40      <TD width="87%">An error is being generated or execution is impossible because matchmaking is not in progress or cancellation is already under way.</TD>
41    </TR>
42
43  </TBODY>
44</TABLE>
45
46<H2>Description</H2>
47<p>This function cancels the matchmaking in progress.</p><p>The cancel process completes inside this function, and a matching completion callback function (<a href=DWCMatchedSCCallback.html#dwc__match_8h_169fa2126df86bf98f54258f5ccab9beb><CODE>DWCMatchedSCCallback</CODE></a>) is called. When that happens, the <CODE>cancel</CODE> argument of the callback function is TRUE.</p><p>To check whether cancellation is currently possible, use the <a href=DWC_IsValidCancelMatch.html#dwc__match_8h_1db395bebdd9ee8ab19b883e7ec029b8b><CODE>DWC_IsValidCancelMatch</CODE></a> function.</p><p>Only use this function when the local host has not connected to anyone else yet. Use the <a href=DWC_CloseAllConnectionsHard.html#dwc__main_8h_1123f5a62315e3eae575e961c8a2133e3><CODE>DWC_CloseAllConnectionsHard</CODE></a> function when the local host has connected to someone even once.</p>
48
49<H2>Revision History</H2>
50<DL>
51
52<DT><para>2.0.0</DT>
53<DD>Added a Note directing to only use this function when the local host has not yet connected to anyone else.</DD>
54
55<DT><para>2.0.0</DT>
56<DD>Removed the description of <CODE>DWCMatchedCallback</CODE>.</DD>
57
58</DL>
59<hr><p>CONFIDENTIAL</p></body>
60</html>
61