IBackgroundCopyError::GetFile method
Retrieves an interface pointer to the file object associated with the error.
Syntax
HRESULT GetFile(
[out] IBackgroundCopyFile **ppFile
);
Parameters
-
ppFile [out]
-
An IBackgroundCopyFile interface pointer whose methods you use to determine the local and remote file names associated with the error. The ppFile parameter is set to NULL if the error is not associated with the local or remote file. When done, release ppFile.
Return value
This method returns the following HRESULT values.
| Return code | Description |
|---|---|
|
Successfully retrieved an interface pointer to the file object. |
|
The error is not associated with a local or remote file. The ppFile parameter is set to NULL. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 10, version 1709 [desktop apps only] |
| Minimum supported server |
Windows Server, version 1709 [desktop apps only] |
| Header |
|
| IDL |
|
| Library |
|
| DLL |
|
| IID |
IID_IBackgroundCopyError is defined as 19C613A0-FCB8-4F28-81AE-897C3D078F81 |