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

Recupera el nombre local del archivo.

Sintaxis

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

Parámetros

[out] pVal

Cadena terminada en NULL que contiene el nombre del archivo en el cliente. El nombre está completo. Llame a la función CoTaskMemFree para liberar ppName cuando haya terminado.

Valor devuelto

Este método devuelve S_OK si se ejecuta correctamente o uno de los valores COM HRESULT estándar en caso de error.

Comentarios

El nombre de archivo local se establece al llamar a los métodos AddFile o AddFileSet de la interfaz IBackgroundCopyJob .

Ejemplos

En el ejemplo siguiente se muestra cómo recuperar los nombres de archivo locales y remotos y la información relacionada con el progreso de .
Interfaz IBackgroundCopyFile . En el ejemplo se supone que el puntero de interfaz IBackgroundCopyFile es 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 Value
Cliente mínimo compatible Windows XP
Servidor mínimo compatible Windows Server 2003
Plataforma de destino Windows
Encabezado bits.h
Library Bits.lib
Archivo DLL QmgrPrxy.dll

Consulte también

IBackgroundCopyFile

IBackgroundCopyFile::GetRemoteName

IBackgroundCopyJob::AddFile

IBackgroundCopyJob::AddFileSet