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_GetConnectionUserData</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__match_8h_1577cae4a5e85518c7f385458b836732c"></a>
14<h1 align="left">DWC_GetConnectionUserData</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_GetConnectionUserData.html#dwc__match_8h_1577cae4a5e85518c7f385458b836732c>DWC_GetConnectionUserData</a>(u8 aid,
22                               u8 *userData);</CODE></PRE></dd>
23</dl>
24
25<h2>Arguments</h2>
26
27<TABLE border="1" width="100%">
28  <TBODY>
29
30    <TR>
31      <TD width="13%"><EM><STRONG>aid</STRONG></EM></TD>
32      <TD width="87%">The AID for the host whose <CODE>connectionUserData</CODE> you want to get. This data was set at the time of the host's connection.</TD>
33    </TR>
34
35    <TR>
36      <TD width="13%"><EM><STRONG>userData</STRONG></EM></TD>
37      <TD width="87%">The buffer for the <CODE>connectionUserData</CODE>. Must be a buffer of length <CODE>u8[<a href=Macro.html#dwc__match_8h_1767334491be60055db279f50c050c695>DWC_CONNECTION_USERDATA_LEN</a>]</CODE>.</TD>
38    </TR>
39
40  </TBODY>
41</TABLE>
42
43<h2>Return Values</h2>
44
45<TABLE border="1" width="100%">
46  <TBODY>
47
48    <TR>
49      <TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD>
50      <TD width="87%">Succeeded in getting <CODE>userData</CODE>.</TD>
51    </TR>
52
53    <TR>
54      <TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
55      <TD width="87%">Failed to get <CODE>userData</CODE>.</TD>
56    </TR>
57
58  </TBODY>
59</TABLE>
60
61<H2>Description</H2>
62<p>Gets the <CODE>connectionUserData</CODE> of an already-connected host. This data was configured when the host made the connection. This function was designed to be used within the <a href=DWCConnectAttemptCallback.html#dwc__match_8h_11f5ec37975abd1264f03e7d9247c34bf><CODE>DWCConnectAttemptCallback</CODE></a> function to help determine whether to accept new connection hosts.</p>
63
64<H2>Revision History</H2>
65<DL>
66
67<DT><para>2.0.0</DT>
68<DD>Initial addition.</DD>
69
70</DL>
71<hr><p>CONFIDENTIAL</p></body>
72</html>
73