DWC_NdCancelAsync

Syntax

#include <dwc.h>
BOOL DWC_NdCancelAsync(void);

Arguments

None.

Return Values

TRUE Success.
FALSE Either the function failed, or there was no cancellable asynchronous process.

Description

Cancels the asynchronous process currently run by the Download library.

Cancels processing of the DWC_NdGetFileListNumAsync, DWC_NdGetFileListAsync, and DWC_NdGetFileAsync functions.

If this function has returned TRUE, the DWCNdCallback type callback function specified by DWC_NdInitAsync is called when cancellation completes. When this happens, DWC_ND_ERROR_CANCELED is filled in for the error argument of the callback function.

This function returns FALSE if cancellation fails or if there was no cancellable asynchronous process.
Note: If cancellation fails, you must wait until the asynchronous function that you tried to cancel completes.

The DWC_NdInitAsync and DWC_NdCleanupAsync functions cannot be canceled. FALSE is always returned if an attempt is made to cancel any of these functions.

This function includes an internal call of the SOC_Shutdown function, so it may block the current thread for one or two seconds.

See Also

DWC_NdGetFileListNumAsync
DWC_NdGetFileListAsync
DWC_NdGetFileAsync

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL