IBackgroundCopyFile::GetLocalName-Methode (bits.h)

Artikel
02/28/2024

Ruft den lokalen Namen der Datei ab.

Syntax

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

Parameter

[out] pVal

Null-beendete Zeichenfolge, die den Namen der Datei auf dem Client enthält. Der Name ist voll qualifiziert. Rufen Sie die CoTaskMemFree-Funktion auf, um ppName frei zu geben, wenn Sie fertig sind.

Rückgabewert

Diese Methode gibt S_OK bei Erfolg oder einen der COM HRESULT-Standardwerte bei Fehler zurück.

Hinweise

Der lokale Dateiname wird festgelegt, wenn Sie die AddFile- oder AddFileSet-Methoden der IBackgroundCopyJob-Schnittstelle aufrufen.

Beispiele

Das folgende Beispiel zeigt, wie Sie die lokalen Und Remotedateinamen und statusbezogenen Informationen aus dem
IBackgroundCopyFile-Schnittstelle . Im Beispiel wird davon ausgegangen, dass der IBackgroundCopyFile-Schnittstellenzeiger gültig ist.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP
Unterstützte Mindestversion (Server)	Windows Server 2003
Zielplattform	Windows
Kopfzeile	bits.h
Bibliothek	Bits.lib
DLL	QmgrPrxy.dll