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_NdCancelAsync</title> 9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13<a name="dwc__nd_8h_15c3d33475672f692d85e6540d5ab3a46"></a> 14<h1 align="left">DWC_NdCancelAsync</h1> 15<h2>Syntax</h2> 16 17<dl> 18 <dd> 19<CODE>#include <dwc.h></CODE><BR> 20 <BR> 21 <PRE><CODE>BOOL <a href=DWC_NdCancelAsync.html#dwc__nd_8h_15c3d33475672f692d85e6540d5ab3a46>DWC_NdCancelAsync</a>(void);</CODE></PRE></dd> 22</dl> 23 24<h2>Arguments</h2> 25 26<p>None.</p> 27 28<h2>Return Values</h2> 29 30<TABLE border="1" width="100%"> 31 <TBODY> 32 33 <TR> 34<TD width="13%"><EM><STRONG>TRUE</STRONG></EM></TD> 35<TD width="87%">Successful. Upon completion, the <a href=DWC_NdProcess.html><CODE>DWC_NdProcess</CODE></a> function returns <a href=Macro.html#dwc__nd_8h_16dd63254afcd3d1cc5f3a7851c0c8ef18e7a759f648afeb1195a22d035819d07><CODE>DWC_ND_STATE_ERROR</CODE></a>. You can get <a href=Macro.html#dwc__error_8h_106fc87d81c62e9abb8790b6e5713c55b9b2cab5bf6467079b8676ce52f6beb9b><CODE>DWC_ECODE_TYPE_ND_CANCEL</CODE></a> by using the <a href=DWC_GetLastErrorEx.html#dwc__error_8h_118bd79f5d5151259c19c4e552e5e633b><CODE>DWC_GetLastErrorEx</CODE></a> function.</TD> 36 </TR> 37 38 <TR> 39<TD width="13%"><EM><STRONG>FALSE</STRONG></EM></TD> 40<TD width="87%">The function either failed or there was no asynchronous process to be canceled. Use the <a href=DWC_GetLastErrorEx.html#dwc__error_8h_118bd79f5d5151259c19c4e552e5e633b><code>DWC_GetLastErrorEx</code></a> function to obtain error information.</TD> 41 </TR> 42 43 </TBODY> 44</TABLE> 45 46<H2>Description</H2> 47<p>Cancels the HTTP process that the download library is currently running.</p><p>Cancels processing of the <a href=DWC_NdGetFileListNumAsync.html><CODE>DWC_NdGetFileListNumAsync</CODE></a>, <a href=DWC_NdGetFileListAsync.html><CODE>DWC_NdGetFileListAsync</CODE></a>, and <a href=DWC_NdGetFileAsync.html><CODE>DWC_NdGetFileAsync</CODE></a> functions.</p><p>When <CODE>TRUE</CODE> is returned, upon completion the <a href=DWC_NdProcess.html><CODE>DWC_NdProcess</CODE></a> function returns <a href=Macro.html#dwc__nd_8h_16dd63254afcd3d1cc5f3a7851c0c8ef18e7a759f648afeb1195a22d035819d07><CODE>DWC_ND_STATE_ERROR</CODE></a>, and you can obtain <a href=Macro.html#dwc__error_8h_106fc87d81c62e9abb8790b6e5713c55b9b2cab5bf6467079b8676ce52f6beb9b><CODE>DWC_ECODE_TYPE_ND_CANCEL</CODE></a> by using the <a href=DWC_GetLastErrorEx.html#dwc__error_8h_118bd79f5d5151259c19c4e552e5e633b><CODE>DWC_GetLastErrorEx</CODE></a> function.</p><p>The function returns <CODE>FALSE</CODE> if the cancellation process fails or if there are no asynchronous processes that need to be canceled. You can obtain <a href=Macro.html#dwc__error_8h_106fc87d81c62e9abb8790b6e5713c55b9dd05097c466efa38ad727c68e267cff><CODE>DWC_ECODE_TYPE_ND_STATE</CODE></a> by using the <a href=DWC_GetLastErrorEx.html#dwc__error_8h_118bd79f5d5151259c19c4e552e5e633b><CODE>DWC_GetLastErrorEx</CODE></a> function.</p><p><STRONG>Note:</STRONG> If cancellation fails, you must wait until the asynchronous function that you tried to cancel completes.</p><p>The <a href=DWC_NdInitAsync.html><CODE>DWC_NdInitAsync</CODE></a> and <a href=DWC_NdCleanupAsync.html><CODE>DWC_NdCleanupAsync</CODE></a> functions cannot be canceled. If an attempt is made to cancel either one of these functions, <CODE>FALSE</CODE> is always returned. You can obtain <a href=Macro.html#dwc__error_8h_106fc87d81c62e9abb8790b6e5713c55b9dd05097c466efa38ad727c68e267cff><CODE>DWC_ECODE_TYPE_ND_STATE</CODE></a> by using the <a href=DWC_GetLastErrorEx.html#dwc__error_8h_118bd79f5d5151259c19c4e552e5e633b><CODE>DWC_GetLastErrorEx</CODE></a> function.</p> 48 49<h2>See Also</h2> 50<p> 51 52<CODE><A href="DWC_NdGetFileListNumAsync.html">DWC_NdGetFileListNumAsync<BR></A></CODE> 53 54<CODE><A href="DWC_NdGetFileListAsync.html">DWC_NdGetFileListAsync<BR></A></CODE> 55 56<CODE><A href="DWC_NdGetFileAsync.html">DWC_NdGetFileAsync<BR></A></CODE> 57 58<CODE><A href="DWC_GetLastErrorEx.html">DWC_GetLastErrorEx<BR></A></CODE> 59 60</p> 61 62<H2>Revision History</H2> 63<DL> 64 65<DT><para>1.4.12</DT> 66<DD>Revised the error code descriptions.</DD> 67 68<DT><para>1.4.7</DT> 69<DD>Added a description of usage.</DD> 70 71</DL> 72<hr><p>CONFIDENTIAL</p></body> 73</html> 74