IBackgroundCopyJob interface (bits.h)

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.

Inheritance

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

Methods

The IBackgroundCopyJob interface has these methods.

 
IBackgroundCopyJob::AddFile

Adds a single file to the job.
IBackgroundCopyJob::AddFileSet

Adds multiple files to a job.
IBackgroundCopyJob::Cancel

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

Ends the job and saves the transferred files on the client.
IBackgroundCopyJob::EnumFiles

Retrieves an IEnumBackgroundCopyFiles interface pointer that you use to enumerate the files in a job.
IBackgroundCopyJob::GetDescription

Retrieves the description of the job.
IBackgroundCopyJob::GetDisplayName

Retrieves the display name for the job. Typically, you use the display name to identify the job in a user interface.
IBackgroundCopyJob::GetError

Retrieves the error interface after an error occurs.
IBackgroundCopyJob::GetErrorCount

Retrieves the number of times BITS tried to transfer the job and an error occurred.
IBackgroundCopyJob::GetId

Retrieves the identifier used to identify the job in the queue.
IBackgroundCopyJob::GetMinimumRetryDelay

Retrieves the minimum length of time that the service waits after encountering a transient error condition before trying to transfer the file.
IBackgroundCopyJob::GetNoProgressTimeout

Retrieves the length of time that the service tries to transfer the file after a transient error condition occurs. If there is progress, the timer is reset.
IBackgroundCopyJob::GetNotifyFlags

Retrieves the event notification flags for the job.
IBackgroundCopyJob::GetNotifyInterface

Retrieves the interface pointer to your implementation of the IBackgroundCopyCallback interface.
IBackgroundCopyJob::GetOwner

Retrieves the identity of the job's owner.
IBackgroundCopyJob::GetPriority

Retrieves the priority level for the job. The priority level determines when the job is processed relative to other jobs in the transfer queue.
IBackgroundCopyJob::GetProgress

Retrieves job-related progress information, such as the number of bytes and files transferred.
IBackgroundCopyJob::GetProxySettings

Retrieves the proxy information that the job uses to transfer the files.
IBackgroundCopyJob::GetState

Retrieves the state of the job.
IBackgroundCopyJob::GetTimes

Retrieves job-related time stamps, such as the time that the job was created or last modified.
IBackgroundCopyJob::GetType

Retrieves the type of transfer being performed, such as a file download or upload.
IBackgroundCopyJob::Resume

Activates a new job or restarts a job that has been suspended.
IBackgroundCopyJob::SetDescription

Provides a description of the job.
IBackgroundCopyJob::SetDisplayName

Specifies a display name for the job. Typically, you use the display name to identify the job in a user interface.
IBackgroundCopyJob::SetMinimumRetryDelay

Sets the minimum length of time that BITS waits after encountering a transient error condition before trying to transfer the file.
IBackgroundCopyJob::SetNoProgressTimeout

Sets the length of time that BITS tries to transfer the file after a transient error condition occurs. If there is progress, the timer is reset.
IBackgroundCopyJob::SetNotifyFlags

Specifies the type of event notification you want to receive, such as job transferred events.
IBackgroundCopyJob::SetNotifyInterface

Identifies your implementation of the IBackgroundCopyCallback interface to BITS. Use the IBackgroundCopyCallback interface to receive notification of job-related events.
IBackgroundCopyJob::SetPriority

Specifies the priority level of your job. The priority level determines when your job is processed relative to other jobs in the transfer queue.
IBackgroundCopyJob::SetProxySettings

Specifies which proxy to use to transfer files.
IBackgroundCopyJob::Suspend

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

Changes ownership of the job to the current user.

Requirements

   
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Target Platform Windows
Header bits.h

See also

IBackgroundCopyFile

IBackgroundCopyJob2

IBackgroundCopyJob3

IBackgroundCopyManager

IEnumBackgroundCopyJobs