Export (0) Print
Expand All

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

The IBackgroundCopyJob interface has these methods.

MethodDescription
AddFile

Adds a single file to the job.

AddFileSet

Adds multiple files to the job.

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.

GetDescription

Retrieves the description of the job.

GetDisplayName

Retrieves the display name that identifies the job.

GetError

Retrieves an interface pointer to the error object after an error occurs.

GetErrorCount

Retrieves the number of times the job was interrupted by network failure or server unavailability.

GetId

Retrieves the identifier of the job in the queue.

GetMinimumRetryDelay

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

GetNoProgressTimeout

Retrieves the length of time that BITS 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).

GetOwner

Retrieves the job owner's identity.

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.

GetProxySettings

Retrieves the proxy settings the job uses to transfer the files.

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

Restarts a suspended job.

SetDescription

Specifies a description of the job.

SetDisplayName

Specifies a display name that identifies the job in a user interface.

SetMinimumRetryDelay

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

SetNoProgressTimeout

Specifies the length of time that BITS 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.

SetProxySettings

Specifies which proxy to use to transfer the files.

Suspend

Pauses the job.

TakeOwnership

Changes the ownership of the job to the current user.

 

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Bits.h

IDL

Bits.idl

Library

Bits.lib

DLL

QmgrPrxy.dll

IID

IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

IBackgroundCopyFile
IBackgroundCopyJob2
IBackgroundCopyJob3
IBackgroundCopyManager
IEnumBackgroundCopyJobs

 

 

Community Additions

ADD
Show:
© 2014 Microsoft