IBackgroundCopyFile::GetRemoteName method

Retrieves the remote name of the file.

Syntax

HRESULT GetRemoteName(
  [out] LPWSTR *ppName
);

Parameters

ppName [out]

Null-terminated string that contains the remote name of the file to transfer. The name is fully qualified. Call the CoTaskMemFree function to free ppName when done.

Return value

This method returns S_OK on success or one of the standard COM HRESULT values on error.

Remarks

To change the remote file name, call the IBackgroundCopyFile2::SetRemoteName method.

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

IBackgroundCopyFile

IBackgroundCopyFile::GetLocalName