IBackgroundCopyJob interface

Use the IBackgroundCopyJob interface to add files to the job, set the priority level of the job, determine the state of the job, and to start and stop the job.

To create a job, call the IBackgroundCopyManager::CreateJob method. To get an IBackgroundCopyJob interface pointer to an existing job, call the IBackgroundCopyManager::GetJob method.

Members

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

• Methods

Methods

The IBackgroundCopyJob interface has these methods.

Method	Description
Cancel	Cancels the job and removes temporary files from the client.
Complete	Ends the job and saves the transferred files on the client.
EnumFiles	Returns an interface pointer to an enumerator object that you use to enumerate the files in the job.
GetDisplayName	Retrieves the display name that identifies the job.
GetError	Retrieves an interface pointer to the error object after an error occurs.
GetId	Retrieves the identifier of the job in the queue.
GetNoProgressTimeout	Retrieves the length of time that Delivery Optimization continues to try to transfer the file after encountering a transient error condition.
GetNotifyFlags	Retrieves the event notification (callback) flags you have set for your application.
GetNotifyInterface	Retrieves a pointer to your implementation of the IBackgroundCopyCallback interface (callbacks).
GetPriority	Retrieves the priority level you have set for the job.
GetProgress	Retrieves job-related progress information, such as the number of bytes and files transferred to the client.
GetState	Retrieves the state of the job.
GetTimes	Retrieves time stamps for activities related to the job, such as the time the job was created.
GetType	Retrieves the type of transfer being performed, such as a file download.
Resume	Starts a new job or restarts a suspended job.
SetNoProgressTimeout	Specifies the length of time that Delivery Optimization continues to try to transfer the file after encountering a transient error condition.
SetNotifyFlags	Specifies the type of event notification to receive.
SetNotifyInterface	Specifies a pointer to your implementation of the IBackgroundCopyCallback interface (callbacks). The interface receives notification based on the event notification flags you set.
SetPriority	Specifies the priority of the job relative to other jobs in the transfer queue.
Suspend	Pauses the job.

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

IBackgroundCopyFile

IBackgroundCopyManager