Метод IBackgroundCopyFile::GetLocalName (bits.h)

  • Статья

Извлекает локальное имя файла.

Синтаксис

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

Параметры

[out] pVal

Строка, завершающаяся значением NULL, содержащая имя файла на клиенте. Имя является полным. По завершении вызовите функцию CoTaskMemFree , чтобы освободить ppName .

Возвращаемое значение

Этот метод возвращает S_OK при успешном выполнении или одно из стандартных значений COM HRESULT при ошибке.

Комментарии

Имя локального файла задается при вызове методов AddFile или AddFileSet интерфейса IBackgroundCopyJob .

Примеры

В следующем примере показано, как получить имена локальных и удаленных файлов и сведения о ходе выполнения из
Интерфейс 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
Header bits.h
Библиотека Bits.lib
DLL QmgrPrxy.dll

См. также раздел

IBackgroundCopyFile

IBackgroundCopyFile::GetRemoteName

IBackgroundCopyJob::AddFile

IBackgroundCopyJob::AddFileSet