[This topic is pre-release documentation and
is subject to change in future releases. Blank topics are included
as placeholders.]
The IBackgroundCopyJob5type exposes the following methods.
Methods
Public
Protected
|
Instance
Static
|
Declared
Inherited
|
XNA Framework Only
.NET Compact Framework
Only
|
|
Member | Description | |
---|---|---|
AddFile(String, String) |
Adds file to job
|
|
AddFileSet(UInt32, array< BitsFileInfo > [] () [] [] ) |
Add file set to job
|
|
AddFileWithRanges(String, String, UInt32, array< BackgroundFileRange > [] () [] [] ) |
Add a file to a download job and specify the
ranges of the file to download (Inherited from
IBackgroundCopyJob3.) |
|
Cancel () () () () |
Cancels a job
|
|
Complete () () () () |
Completes a job
|
|
EnumFiles(IEnumBackgroundCopyFiles % ) |
Enumerates files in job
|
|
GetDescription(String % ) |
Gets job description
|
|
GetDisplayName(String % ) |
Gets job display name
|
|
GetError(IBackgroundCopyError % ) |
Gets job error state synchronously
|
|
GetErrorCount(UInt32 % ) |
Gets error count
|
|
GetFileACLFlags(UInt32 % ) |
Retrieves the flags that identify the owner
and ACL information to maintain when downloading a file using
SMB (Inherited from
IBackgroundCopyJob3.) |
|
GetId(Guid % ) |
Gets job ID
|
|
GetMaximumDownloadTime(UInt64 % ) |
Gets the maximum time that BITS will spend
transferring files in the job. (Inherited from
IBackgroundCopyJob4.) |
|
GetMinimumRetryDelay(UInt32 % ) |
Gets minimum retry delay
|
|
GetNoProgressTimeout(UInt32 % ) |
Gets timeout on no progress
|
|
GetNotifyCmdLine(String % , String % ) |
Gets notification command line for
job (Inherited from
IBackgroundCopyJob2.) |
|
GetNotifyFlags(UInt32 % ) |
Gets job notification flags
|
|
GetNotifyInterface(IBackgroundCopyCallback % ) |
Gets notification interface
|
|
GetOwner(String % ) |
Gets job owner
|
|
GetOwnerElevationState(Boolean % ) |
Gets a value that determines if the token of
the owner was elevated at the time they created or took ownership
of the job (Inherited from
IBackgroundCopyJob4.) |
|
GetOwnerIntegrityLevel(Int64 % ) |
Gets the integrity level of the token of the
owner that created or took ownership of the job (Inherited
from
IBackgroundCopyJob4.) |
|
GetPeerCachingFlags(PeerCachingFlags % ) |
Gets flags that determine if the files of the
job can be cached and served to peers and if the job can download
content from peers (Inherited from
IBackgroundCopyJob4.) |
|
GetPriority(BitsJobPriority % ) |
Gets job priority
|
|
GetProgress(BitsJobProgress % ) |
Gets job progress synchronously
|
|
GetProperty(BitsJobPropertyId, Object % ) |
Generic job property getter method
|
|
GetProxySettings(BitsJobProxyUsage % , String % , String % ) |
Gets proxy settings for job
|
|
GetReplyData(IntPtr, UInt64 % ) |
Gets reply data for job (Inherited from
IBackgroundCopyJob2.) |
|
GetReplyFileName(String % ) |
Gets reply file name for job (Inherited
from
IBackgroundCopyJob2.) |
|
GetReplyProgress(BitsJobReplyProgress % ) |
Gets reply progress for job (Inherited
from
IBackgroundCopyJob2.) |
|
GetState(BitsJobState % ) |
Gets job state synchronously
|
|
GetTimes(BitsJobTimes % ) |
Gets job times
|
|
GetType(BitsJobType % ) |
Gets job type
|
|
RemoveCredentials(BitsAuthTarget, BitsAuthScheme) |
Removes credentials from job (Inherited
from
IBackgroundCopyJob2.) |
|
ReplaceRemotePrefix(String, String) |
Replace the beginning text of all remote names
in the job with the given string (Inherited from
IBackgroundCopyJob3.) |
|
Resume () () () () |
Resumes a suspended job
|
|
SetCredentials(BitsAuthCredentials % ) |
Sets job credentials (Inherited from
IBackgroundCopyJob2.) |
|
SetDescription(String) |
Sets description for the job
|
|
SetDisplayName(String) |
Sets display name for job
|
|
SetFileACLFlags(UInt32) |
Specifies the owner and ACL information to
maintain when downloading a file using SMB (Inherited from
IBackgroundCopyJob3.) |
|
SetMaximumDownloadTime(UInt64) |
Sets the maximum time BITS will spend
transferring files in the job. Default is 7776000 seconds (90
days) (Inherited from
IBackgroundCopyJob4.) |
|
SetMinimumRetryDelay(UInt32) |
Sets minimum retry delay
|
|
SetNoProgressTimeout(UInt32) |
Sets timeout on no progress
|
|
SetNotifyCmdLine(String, String) |
Sets notification command line for
job (Inherited from
IBackgroundCopyJob2.) |
|
SetNotifyFlags(UInt32) |
Sets job notification flags
|
|
SetNotifyFlags(BitsJobNotificationType) |
Sets notification flags for
job (Inherited from
IBackgroundCopyJob2.) |
|
SetNotifyInterface(IBackgroundCopyCallback) |
Sets notification interface
|
|
SetPeerCachingFlags(PeerCachingFlags) |
Sets flags that determine if the files of the
job can be cached and served to peers and if the job can download
content from peers (Inherited from
IBackgroundCopyJob4.) |
|
SetPriority(BitsJobPriority) |
Sets job priority
|
|
SetProperty(BitsJobPropertyId, Object) |
Generic job property setter method
|
|
SetProxySettings(BitsJobProxyUsage, String, String) |
Sets proxy settings for job
|
|
SetReplyFileName(String) |
Sets reply file name for job (Inherited
from
IBackgroundCopyJob2.) |
|
Suspend () () () () |
Suspends a job
|
|
TakeOwnership () () () () |
Assumes ownership for existing job
|