IBackgroundCopyFile：：GetLocalName 方法 (bits.h)

  • 项目

检索文件的本地名称。

语法

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

参数

[out] pVal

以 Null 结尾的字符串，其中包含客户端上的文件的名称。 该名称是完全限定的。 完成后，调用 CoTaskMemFree 函数以释放 ppName 。

返回值

此方法在成功时返回 S_OK 或错误时返回标准 COM HRESULT 值之一。

注解

调用 IBackgroundCopyJob 接口的 AddFile 或 AddFileSet 方法时，将设置本地文件名。

示例

以下示例演示如何从 检索本地和远程文件名以及与进度相关的信息
IBackgroundCopyFile 接口。 该示例假定 IBackgroundCopyFile 接口指针有效。

IBackgroundCopyFile* pFile;
HRESULT hr;
WCHAR* pszLocalFileName = NULL;
WCHAR* pszRemoteFileName = NULL;
WCHAR  szPercentComplete[4+1];
BG_FILE_PROGRESS Progress;

hr = pFile->GetLocalName(&pszLocalFileName);
if (SUCCEEDED(hr))
{
  hr = pFile->GetRemoteName(&pszRemoteFileName);
  if (SUCCEEDED(hr))
  {
    pFile->GetProgress(&Progress);
    if (BG_SIZE_UNKNOWN == Progress.BytesTotal) 
    {
      StringCchPrintf(szPercentComplete, sizeof(szPercentComplete), L"0%%");
    } 
    else 
    {
      StringCchPrintf(szPercentComplete, sizeof(szPercentComplete), L"%I64d%%", 
          100*Progress.BytesTransferred/Progress.BytesTotal); 
    }
    //Do something with the file names and progress information.
  }
}
if (pszLocalFileName)
  CoTaskMemFree(pszLocalFileName);
if (pszRemoteFileName)
  CoTaskMemFree(pszRemoteFileName);

要求

要求 值
最低受支持的客户端 Windows XP
最低受支持的服务器 Windows Server 2003
目标平台 Windows
标头 bits.h
Library Bits.lib
DLL QmgrPrxy.dll

另请参阅

IBackgroundCopyFile

IBackgroundCopyFile：：GetRemoteName

IBackgroundCopyJob：：AddFile

IBackgroundCopyJob：：AddFileSet