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_Ping</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__transport_8h_12ae31d147a714c085fda0588bbf00763"></a>
14<h1 align="left">DWC_Ping</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_Ping.html#dwc__transport_8h_12ae31d147a714c085fda0588bbf00763>DWC_Ping</a>(u8 aid);</CODE></PRE></dd>
22</dl>
23
24<h2>Arguments</h2>
25
26<TABLE border="1" width="100%">
27  <TBODY>
28
29    <TR>
30<TD width="13%"><EM><STRONG>aid</STRONG></EM></TD>
31<TD width="87%">AID of the other host for which round-trip communication time is being measured.</TD>
32    </TR>
33
34  </TBODY>
35</TABLE>
36
37<h2>Return Values</h2>
38
39<TABLE border="1" width="100%">
40  <TBODY>
41
42    <TR>
43<TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD>
44<TD width="87%">Function completed successfully.</TD>
45    </TR>
46
47    <TR>
48<TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD>
49<TD width="87%">Failure due to either an error being generated or an invalid AID being passed.</TD>
50    </TR>
51
52  </TBODY>
53</TABLE>
54
55<H2>Description</H2>
56<p>Measures the round-trip communication time (in milliseconds) with the host having the specified AID (among all connected hosts). Notification of the measurement results is sent to the Ping callback function set by <a href="DWC_SetUserPingCallback.html"><CODE>DWC_SetUserPingCallback</CODE></a>.</p>
57
58<H2>Revision History</H2>
59<DL>
60
61</DL>
62<hr><p>CONFIDENTIAL</p></body>
63</html>
64