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

Article
03/02/2024

Récupère le nom local du fichier.

Syntaxe

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

Paramètres

[out] pVal

Chaîne terminée par null qui contient le nom du fichier sur le client. Le nom est complet. Appelez la fonction CoTaskMemFree pour libérer ppName lorsque vous avez terminé.

Valeur retournée

Cette méthode retourne S_OK en cas de réussite ou l’une des valeurs COM HRESULT standard en cas d’erreur.

Remarques

Le nom de fichier local est défini lorsque vous appelez les méthodes AddFile ou AddFileSet de l’interface IBackgroundCopyJob .

Exemples

L’exemple suivant montre comment récupérer les noms de fichiers locaux et distants et les informations relatives à la progression à partir du
Interface IBackgroundCopyFile . L’exemple suppose que le pointeur d’interface IBackgroundCopyFile est valide.

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP
Serveur minimal pris en charge	Windows Server 2003
Plateforme cible	Windows
En-tête	bits.h
Bibliothèque	Bits.lib
DLL	QmgrPrxy.dll