IBackgroundCopyJob::Resume method

Activates a new job or restarts a job that has been suspended.

Syntax

HRESULT Resume();

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 restarted.
DO_E_EMPTY
There are no files to transfer.
DO_E_INVALID_STATE
The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

Remarks

When you create a job, the job is initially suspended. Calling Resume moves the job to the Transferring state. Note that the job must contain one or more files before calling this method.

If a job that is in the BG_JOB_STATE_TRANSIENT_ERROR or BG_JOB_STATE_ERROR state, call the Resume method to restart the job after you fix the error.

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::Cancel

IBackgroundCopyJob::Suspend