Método IBackgroundCopyFile::GetLocalName (bits.h)

Recupera o nome local do arquivo.

Sintaxe

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

Parâmetros

[out] pVal

Cadeia de caracteres terminada em nulo que contém o nome do arquivo no cliente. O nome é totalmente qualificado. Chame a função CoTaskMemFree para liberar ppName quando terminar.

Retornar valor

Esse método retorna S_OK com êxito ou um dos valores COM HRESULT padrão no erro.

Comentários

O nome do arquivo local é definido quando você chama os métodos AddFile ou AddFileSet da interface IBackgroundCopyJob .

Exemplos

O exemplo a seguir mostra como recuperar os nomes de arquivo locais e remotos e informações relacionadas ao progresso do
Interface IBackgroundCopyFile . O exemplo pressupõe que o ponteiro da interface IBackgroundCopyFile seja válido.

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);

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP
Servidor mínimo com suporte Windows Server 2003
Plataforma de Destino Windows
Cabeçalho bits.h
Biblioteca Bits.lib
DLL QmgrPrxy.dll

Confira também

IBackgroundCopyFile

IBackgroundCopyFile::GetRemoteName

IBackgroundCopyJob::AddFile

IBackgroundCopyJob::AddFileSet