1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<TITLE>NWC24IterateDlTask</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8<LINK rel="stylesheet" type="text/css" href="../nwc24.css">
9</HEAD>
10<BODY>
11<H1>NWC24IterateDlTask</H1>
12
13<H2>C Specification</H2>
14<DL>
15<DD><PRE><CODE>#include &lt;revolution/nwc24.h&gt;</CODE></PRE>
16<DD><PRE><CODE><A HREF="../Types/NWC24Err.html">NWC24Err</A> NWC24IterateDlTask( u16* <VAR>id</VAR>, BOOL <VAR>isBegin</VAR> );</CODE></PRE>
17</DL>
18
19<H2>Description</H2>
20<P>
21Gets the download tasks registered to the task list in order from the smallest ID.
22</P>
23
24<P>
25When beginning iteration, specify <CODE>TRUE</CODE> for  <code><VAR>isBegin</VAR></code>. Subsequently, specify <CODE>FALSE</CODE> until <CODE>NWC24_ERR_DONE</CODE> is returned. <BR>When <CODE>TRUE</CODE> is specified for <code><VAR>isBegin</VAR></code> before<code>NWC24_ERR_DONE</code> is returned, the iteration can be done over.
26</P>
27
28
29<H2>Arguments</H2>
30<TABLE border="1" cellpadding="3" cellspacing="0.1" class="argument">
31  <TR>
32<TD class="name"><code><VAR>id</VAR></code></TD>
33    <TD class="description">
34Pointer to the location where the ID of the iterated download tasks will be stored.
35    </TD>
36  </TR>
37  <TR>
38<TD class="name"><code><VAR>isBegin</VAR></code></TD>
39    <TD class="description">
40When <CODE>TRUE</CODE> is specified, gets the task with the smallest ID from the registered list. <BR>When <CODE>FALSE</CODE> is specified, gets the task with the ID after the ID stored in the <code><VAR>id</VAR></code> argument.
41    </TD>
42  </TR>
43</TABLE>
44
45<h2>Return Values</h2>
46<P>
47<code>NWC24_OK</code>: Fetched correctly. (A value was returned to *<code><VAR>id</VAR></code>. The iteration has not ended.))<BR> <code>NWC24_ERR_DONE</code>: Iteration of all download tasks has completed.<BR> <code>NWC24_ERR_INVALID_VALUE</code>: The value of <code><VAR>id</VAR></code> is NULL.<BR>
48</P>
49
50<H2>See Also</H2>
51<P>
52</P>
53
54<H2>Example</H2>
55<blockquote>
56<code><pre>
57{
58NWC24Err err;
59u16 id;
60for( err = NWC24IterateDlTask(&amp;id, TRUE);
61err &gt;= NWC24_OK;
62err = NWC24IterateDlTask(&amp;id, FALSE) )
63    {
64OSReport(&quot;id=%d\n&quot;, id);
65    }
66if (err != NWC24_ERR_DONE)
67    {
68OSHalt(&quot;Failed.\n&quot;);
69    }
70}</pre></code></blockquote>
71
72<H2>Revision History</H2>
73<P>
742007/09/20 Added information on use.
75<BR> 2006/12/05 Initial version.<BR></P>
76
77<hr><p>CONFIDENTIAL</p></body>
78</HTML>