IBackgroundCopyError interface

Use the IBackgroundCopyError interface to determine the cause of an error and if the transfer process can proceed.

Delivery Optimization creates an error object only when the state of the job is BG_JOB_STATE_ERROR or BG_JOB_STATE_TRANSIENT_ERROR. Delivery Optimization does not create an error object when an IBackgroundCopyXXXX interface method fails. The error object is available until Delivery Optimization begins transferring data (the state of the job changes to BG_JOB_STATE_TRANSFERRING) for the job.

To get an IBackgroundCopyError object, call the IBackgroundCopyJob::GetError method.

Members

The IBackgroundCopyError interface inherits from the IUnknown interface. IBackgroundCopyError also has these types of members:

• Methods

Methods

The IBackgroundCopyError interface has these methods.

Method	Description
GetError	Retrieves the error code and identifies the context in which the error occurred.
GetFile	Retrieves an interface pointer to the file object associated with 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_IBackgroundCopyError is defined as 19C613A0-FCB8-4F28-81AE-897C3D078F81

See also

BG_JOB_STATE

IBackgroundCopyJob::GetError

IBackgroundCopyJob::GetState

IBackgroundCopyCallback::JobError