Click or drag to resize

BackgroundCopyJob Methods

The BackgroundCopyJob type exposes the following members.

Methods
  NameDescription
Public methodAddFile(String, String)
Adds a single file to the job.
Public methodAddFile(Uri, String)
Adds a single file to the job.
Public methodAddFile(String, String, BackgroundCopyFileRange)
Adds a file to a download job and specifies the ranges of the file you want to download.
Public methodAddFile(Uri, String, BackgroundCopyFileRange)
Adds a file to a download job and specifies the ranges of the file you want to download.
Public methodAddFile(String, String, Int64, Int64)
Adds a file to a download job and specifies the range of the file you want to download.
Public methodAddFile(Uri, String, Int64, Int64)
Adds a file to a download job and specifies the range of the file you want to download.
Public methodCode exampleAddFiles
Adds multiple files to the job.
Public methodCancel
Deletes the job from the transfer queue and removes related temporary files from the client (downloads) and server (uploads).
Public methodComplete
Ends the job and saves the transferred files on the client.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEnumerateFiles
Enumerates the files in the job.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Finalizes an instance of the BackgroundCopyJob class.
(Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemoveCredentials
Public methodReplaceRemotePrefix
Replaces the beginning text of all remote names in the download job with the specified string.
Public methodResume
Activates a new job or restarts a job that has been suspended.
Public methodRetrieveError
Retrieves error informations after an error occurs.
Public methodRetrieveProgress
Retrieves job-related progress information, such as the number of bytes and files transferred.
Public methodRetrieveReplyData
Retrieves the reply data from the server application.
Public methodRetrieveReplyProgress
Retrieves progress information that indicates how many bytes of the reply file have been downloaded to the client.
Public methodRetrieveTimes
Retrieves job-related time stamps, such as the time that the job was created or last modified.
Public methodSetCredentials
Specifies the credentials to use for a proxy or remote server user authentication request.
Public methodSuspend
Suspends a job. New jobs, jobs that are in error, and jobs that have finished transferring files are automatically suspended.
Public methodTakeOwnership
Changes ownership of the job to the current user.
Public methodToString
Returns a String that represents this instance.
(Overrides ObjectToString.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetErrorInfo
Gets error informations after an error occurs.
(Defined by BackgroundCopyJobExtensions.)
Public Extension MethodGetPercentBytesTransferred
Gets the percentage of bytes transferred.
(Defined by BackgroundCopyJobExtensions.)
Top
See Also