IBackgroundCopyJob::Complete method (bits.h)
Ends the job and saves the transferred files on the client.
Syntax
HRESULT Complete();
Return value
This method returns the following HRESULT values. The method can also return errors related to renaming the temporary copies of the transferred files to their given names.
| Return code | Description |
|---|---|
|
All files transferred successfully. |
|
A subset of the files transferred successfully. |
|
Job was successfully completed; however, the service was unable to delete the temporary files associated with the job. |
|
For downloads, the state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.
For uploads, the state of the job must be BG_JOB_STATE_TRANSFERRED. |
Remarks
Download files are not available until you call the Complete method. Call the Complete method after BITS successfully transfers the files. The method renames the temporary download files to their final destination names and removes the job from the queue. Note that BITS renames the temporary upload file when the server receives the last fragment, which is why download jobs require network connectivity and upload jobs do not.
All of the files have been successfully transferred if the job's state is BG_JOB_STATE_TRANSFERRED. To check the state of the job, call the IBackgroundCopyJob::GetState method. You can also implement the IBackgroundCopyCallback interface to receive notification when all of the files have been transferred to the client.
If you do not call the Complete method or the IBackgroundCopyJob::Cancel method within 90 days (default JobInactivityTimeout Group Policy), the service cancels the job. If the service cancels the job, the downloaded files and the reply file are not available to the client; job cancellation does not affect files that have been successfully uploaded.
BITS removes the job from the transfer queue if the HRESULT is S_OK or BG_S_PARTIAL_COMPLETE. The job remains in the transfer queue if BITS was unable to rename all of the temporary files. Files that were renamed successfully are available to the user. The job remains in the queue (the state is BG_JOB_STATE_TRANSFERRED) until the application is able to fix the problem and calls either the Complete method again or the IBackgroundCopyJob::Cancel method to cancel the job. To determine which files were not renamed for download jobs, see the Completed member of the BG_FILE_PROGRESS structure.
For download jobs, you can call the Complete method at anytime during the transfer process; however, only files that were successfully transferred to the client before calling this method are saved. For example, if you call the Complete method while BITS is processing the third of five files, only the first two files are saved. To determine which files have been transferred, call the IBackgroundCopyFile::GetProgress method and compare the BytesTransferred member to the BytesTotal member of the BG_FILE_PROGRESS structure.
For upload jobs, you can call the Complete method only when the job's state is BG_JOB_STATE_TRANSFERRED.
BITS does not guarantee the integrity of the transferred files against third-party intrusions. Clients can implement integrity checks to validate transferred files after calling the Complete method.
The owner of the file is the user who made the call. For example, if an administrator completes someone else's job, the administrator—not the owner of the job—owns the file.
BITS 1.2 and earlier: The owner of the file is the owner of the job, regardless of who called the Complete method.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP |
| Minimum supported server | Windows Server 2003 |
| Target Platform | Windows |
| Header | bits.h |
| Library | Bits.lib |
| DLL | QmgrPrxy.dll |
See also
Completing and Canceling a Job