DWC_NdCancelAsync

構文

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

引数

なし

返り値

TRUE 成功。
FALSE 失敗、あるいはキャンセルすべき非同期処理がなかった。

説明

現在ダウンロードライブラリが実行中の非同期処理を中断します。

DWC_NdGetFileListNumAsync関数、DWC_NdGetFileListAsync関数、DWC_NdGetFileAsync関数の処理をキャンセルします。

TRUEを返したときは完了時にDWC_NdInitAsync関数で指定したDWCNdCallback型のコールバック関数が呼び出されます。このとき、コールバック関数の引数errorとしてDWC_ND_ERROR_CANCELEDが入ります。

キャンセルに失敗もしくはキャンセルすべき非同期処理がなかった場合、FALSEが返されます。
キャンセルに失敗した場合、キャンセルしようとした非同期関数が完了するのを待たなければならないことに注意してください。

DWC_NdInitAsync関数とDWC_NdCleanupAsync関数はキャンセルできません。これらの関数をキャンセルしようとしたときは必ずFALSEが返ります。

本関数は、内部で呼ばれるSOC_Shutdown関数の処理を待つため、カレントスレッドを1、2秒ブロックすることがあります。

参照

DWC_NdGetFileListNumAsync DWC_NdGetFileListAsync DWC_NdGetFileAsync

履歴

5.1pr2より前の変更履歴はこちら