Metodo IBackgroundCopyFile::GetLocalName (bits.h)

Articolo
02/28/2024

Recupera il nome locale del file.

Sintassi

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

Parametri

[out] pVal

Stringa con terminazione Null contenente il nome del file nel client. Il nome è completo. Chiamare la funzione CoTaskMemFree per liberare ppName al termine.

Valore restituito

Questo metodo restituisce S_OK in caso di esito positivo o uno dei valori HRESULT COM standard in caso di errore.

Commenti

Il nome del file locale viene impostato quando si chiamano i metodi AddFile o AddFileSet dell'interfaccia IBackgroundCopyJob.

Esempio

Nell'esempio seguente viene illustrato come recuperare i nomi di file locali e remoti e le informazioni relative allo stato dall'oggetto
Interfaccia IBackgroundCopyFile. Nell'esempio si presuppone che il puntatore all'interfaccia IBackgroundCopyFile sia valido.

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

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP
Server minimo supportato	Windows Server 2003
Piattaforma di destinazione	Windows
Intestazione	bits.h
Libreria	Bits.lib
DLL	QmgrPrxy.dll