IBackgroundCopyFile interface

IBackgroundCopyFile contains information about a file that is part of a job. For example, you can use IBackgroundCopyFile methods to retrieve the local and remote names of the file and transfer progress information.

To get an IBackgroundCopyFile interface pointer, call the IBackgroundCopyError::GetFile method or the IEnumBackgroundCopyFiles::Next method.

Members

The IBackgroundCopyFile interface inherits from the IUnknown interface. IBackgroundCopyFile also has these types of members:

Methods

The IBackgroundCopyFile interface has these methods.

Method Description
GetLocalName Retrieves the local name of the file.
GetProgress Retrieves the progress of the file transfer.
GetRemoteName Retrieves the remote name of the file.

Requirements

Requirement Value
Minimum supported client
Windows 10, version 1709 [desktop apps only]
Minimum supported server
Windows Server, version 1709 [desktop apps only]
Header
Deliveryoptimization.h
IDL
DeliveryOptimization.idl
Library
Dosvc.lib
DLL
Dosvc.dll
IID
IID_IBackgroundCopyFile is defined as 01B7BD23-FB88-4A77-8490-5891D3E4653A

See also

IBackgroundCopyError

IBackgroundCopyFile2

IBackgroundCopyJob

IEnumBackgroundCopyFiles