Edit

Share via

IBackgroundCopyJob::Suspend method

  • Article

Suspends a job. New jobs, jobs that are in error, and jobs that have finished transferring files are automatically suspended.

Syntax

HRESULT Suspend();

Parameters

This method has no parameters.

Return value

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

Return code Description
S_OK
 Successfully suspended the job.
DO_E_INVALID_STATE
 The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

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