IBackgroundCopyJob::Cancel method

Deletes the job from the transfer queue and removes related temporary files from the client (downloads) and server (uploads).

Syntax

HRESULT Cancel();

Parameters

This method has no parameters.

Return value

This method returns the following HRESULT values, as well as others.

Return code Description
S_OK
Job was successfully canceled.
DO_E_INVALID_STATE
Cannot cancel a job whose state is BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

Remarks

You can cancel a job at any time; however, the job cannot be recovered after it is canceled.

Requirements

Requirement Value
Minimum supported client
Windows 10, version 1709 [desktop apps only]
Minimum supported server
Windows Server, version 1709 [desktop apps only]
Header
Deliveryoptimization.h
IDL
DeliveryOptimization.idl
Library
Dosvc.lib
DLL
Dosvc.dll
IID
IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

IBackgroundCopyJob

IBackgroundCopyJob::Complete

IBackgroundCopyJob::Resume

IBackgroundCopyJob::Suspend