IBackgroundCopyError interface (bits.h)
Use the
IBackgroundCopyError interface to determine the cause of an error and if the transfer process can proceed.
BITS creates an error object only when the state of the job is BG_JOB_STATE_ERROR or BG_JOB_STATE_TRANSIENT_ERROR. BITS does not create an error object when an IBackgroundCopyXXXX interface method fails. The error object is available until BITS begins transferring data (the state of the job changes to BG_JOB_STATE_TRANSFERRING) for the job or until your application exits.
To get an IBackgroundCopyError object, call the IBackgroundCopyJob::GetError method.
Inheritance
The IBackgroundCopyError interface inherits from the IUnknown interface. IBackgroundCopyError also has these types of members:
Methods
The IBackgroundCopyError interface has these methods.
| IBackgroundCopyError::GetError Retrieves the error code and identify the context in which the error occurred. |
| IBackgroundCopyError::GetErrorContextDescription Retrieves the description of the context in which the error occurred. |
| IBackgroundCopyError::GetErrorDescription Retrieves the error text associated with the error. |
| IBackgroundCopyError::GetFile Retrieves an interface pointer to the file object associated with the error. |
| IBackgroundCopyError::GetProtocol Retrieves the protocol used to transfer the file. The remote file name identifies the protocol to use to transfer the file. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP |
| Minimum supported server | Windows Server 2003 |
| Target Platform | Windows |
| Header | bits.h |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for