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 name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>WBT_GetCurrentDownloadProgress</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WBT_GetCurrentDownloadProgress&nbsp;<img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/wbt.h&gt;</CODE><BR>
20  <BR>
21  <CODE>BOOL WBT_GetCurrentDownloadProgress(u32 block_id, int aid,
22	int *current_count, int *total_count);</CODE><br>
23  <br>
24  </dd>
25</dl>
26<h2>Arguments</h2>
27<p>
28<TABLE border="1" width="100%">
29  <TBODY>
30    <TR>
31      <TD width="13%"><EM><STRONG>block_id</STRONG></EM></TD>
32      <TD width="87%">The <CODE>ID</CODE> of the data block being received for which you want to acquire progress status.</TD>
33    </TR>
34    <TR>
35      <TD width="13%"><EM><STRONG>aid</STRONG></EM></TD>
36      <TD width="87%">The <CODE>AID</CODE> of the receive target for which you want to acquire progress status.</TD>
37    </TR>
38    <TR>
39      <TD width="13%"><EM><STRONG>current_count</STRONG></EM></TD>
40      <TD width="87%">The pointer for storing the number of packets received.</TD>
41    </TR>
42    <TR>
43      <TD width="13%"><EM><STRONG>total_count</STRONG></EM></TD>
44      <TD width="87%">The pointer for storing the total number of packets.</TD>
45    </TR>
46  </TBODY>
47</TABLE>
48</p>
49
50<h2>Return Values</h2>
51<p>If the specified block is being received, this function stores progress information and returns <CODE>TRUE</CODE>. Otherwise, it does nothing and returns <CODE>FALSE</CODE>.</p>
52
53<H2>Description</H2>
54<p>If the specified data block is currently being received by the <A href="../command/WBT_GetBlock.html"><code>WBT_GetBlock</code></A> function, this function gets the progress status as:<br> &quot;Number of packets received / Total number of packets&quot;. <br>
55</p>
56<h2>See Also</h2>
57<p>
58<A href="../command/WBT_GetBlock.html">WBT_GetBlock</A>
59</p>
60<H2>Revision History</H2>
61<P>
622004/09/21 Initial version.
63</P>
64<hr><p>CONFIDENTIAL</p></body>
65</html>
66