NWC24IterateDlTask

Syntax

#include <revolution/nwc24.h>

NWC24Err NWC24IterateDlTask( u16* id, BOOL isBegin );

Description

Gets the download tasks registered to the task list in order from the smallest ID.

When beginning an iteration, specifies TRUE for isBegin. Subsequently, specifies FALSE until NWC24_ERR_DONE is returned.

If you specify TRUE for isBegin before NWC24_ERR_DONE is returned, you can start the iteration over again.

Arguments

`id`	Pointer to the location where the ID of the iterated download tasks will be stored.
`isBegin`	When `TRUE` is specified, gets the task with the smallest ID from the registered list. When `FALSE` is specified, gets the task with the ID after the ID stored in the `id` argument.

Return Values

NWC24_OK: Fetched correctly. (A value was returned to *id. The iteration has not ended.))
NWC24_ERR_DONE: Iteration of all download tasks has completed.
NWC24_ERR_INVALID_VALUE: The value of id is NULL.

Example

{
NWC24Err err;
u16 id;
for( err = NWC24IterateDlTask(&id, TRUE);
err >= NWC24_OK;
err = NWC24IterateDlTask(&id, FALSE) )
    {
OSReport("id=%d\n", id);
    }
if (err != NWC24_ERR_DONE)
    {
OSHalt("Failed.\n");
    }
}

Revision History

2007/09/20 Added information on use.
2006/12/05 Initial version.

CONFIDENTIAL