IBackgroundCopyJob::Cancel メソッド (bits.h)

  • [アーティクル]

転送キューからジョブを削除し、クライアント (ダウンロード) とサーバー (アップロード) から関連する一時ファイルを削除します。

構文

HRESULT Cancel();

戻り値

このメソッドは、次の HRESULT 値と他の値を返します。

リターン コード 説明
S_OK
 ジョブが正常に取り消されました。
BG_S_UNABLE_TO_DELETE_FILES
 ジョブが正常に取り消されました。ただし、サービスはジョブに関連付けられている一時ファイルを削除できませんでした。
BG_E_INVALID_STATE
 状態がBG_JOB_STATE_CANCELLEDまたはBG_JOB_STATE_ACKNOWLEDGEDジョブを取り消すことはできません。

注釈

ジョブはいつでも 取り消 すことができます。ただし、ジョブは取り消された後は回復できません。

アップロード ジョブの場合、サーバーが使用できない場合は、BITS によってキューからジョブが削除されるまでに遅延が発生する可能性があります。 BITS は、BITS サーバーに取り消し要求を最大 24 時間定期的に送信します。 サーバーが 24 時間以内に応答しない場合、BITS はキューからジョブを削除します。 進行なしタイムアウト期間が 24 時間未満の場合、BITS では、非進行状況タイムアウト期間を使用して再試行を制限します。

アップロードが完了していない場合、 Cancel メソッドはアップロードを取り消します。 アップロードが完了し、ジョブの種類が BG_JOB_TYPE_UPLOAD_REPLY の場合、メソッドは応答を取り消します。

要件

要件 値
サポートされている最小のクライアント Windows XP
サポートされている最小のサーバー Windows Server 2003
対象プラットフォーム Windows
ヘッダー bits.h
Library Bits.lib
[DLL] QmgrPrxy.dll

こちらもご覧ください

IBackgroundCopyJob::Complete

IBackgroundCopyJob::Resume

IBackgroundCopyJob::Suspend