IBackgroundCopyError interface
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.
Members
The IBackgroundCopyError interface inherits from the IUnknown interface. IBackgroundCopyError also has these types of members:
Methods
The IBackgroundCopyError interface has these methods.
| Method | Description |
|---|---|
| GetError |
Retrieves the error code and identifies the context in which the error occurred. |
| GetErrorContextDescription |
Retrieves a description of the context in which the error occurred. |
| GetErrorDescription |
Retrieves the error text associated with the error. |
| GetFile |
Retrieves an interface pointer to the file object associated with the error. |
| GetProtocol |
Retrieves the protocol used to transfer the file. |
Requirements
|
Minimum supported client | Windows XP, Windows 2000 Professional with SP3 [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2003, Windows 2000 Server with SP3 [desktop apps only] |
|
Header |
|
|
IDL |
|
|
Library |
|
|
DLL |
|
|
IID |
IID_IBackgroundCopyError is defined as 19C613A0-FCB8-4F28-81AE-897C3D078F81 |
See also
- BG_JOB_STATE
- IBackgroundCopyJob::GetError
- IBackgroundCopyJob::GetState
- IBackgroundCopyCallback::JobError
- IBackgroundCopyManager::GetErrorDescription
Send comments about this topic to Microsoft
Build date: 11/12/2012
