IBackgroundCopyFile::GetRemoteName method (bits.h)

Retrieves the remote name of the file.

Syntax

HRESULT GetRemoteName(
  [out] LPWSTR *pVal
);

Parameters

[out] pVal

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

The remote file name is set when you call the AddFile or AddFileSet methods of the IBackgroundCopyJob interface.

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

Examples

See the example code for the IBackgroundCopyFile::GetLocalName method.

Requirements

   
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Target Platform Windows
Header bits.h
Library Bits.lib
DLL QmgrPrxy.dll

See also

IBackgroundCopyFile

IBackgroundCopyFile::GetLocalName

IBackgroundCopyJob::AddFile

IBackgroundCopyJob::AddFileSet