IBackgroundCopyFile

IBackgroundCopyFile は、ジョブに含まれるファイルに関する情報を保持します。たとえば、IBackgroundCopyFile のメソッドを使用して、ファイルのローカル名およびリモート名や、転送の進行状況に関する情報を取得できます。

ファイルのリモート名を取得します。

このメソッドは、成功した場合は S_OK を返し、エラーの場合は標準的な COM の HRESULT 値のいずれかを返します。

リモートファイル名は、 IBackgroundCopyJob インターフェイスの AddFile メソッドまたは AddFileSet メソッドを呼び出したときに設定されます。

リモートファイル名を変更するには、IBackgroundCopyFile2::SetRemoteName メソッドまたは IBackgroundCopyJob3::ReplaceRemotePrefix メソッドを呼び出します。

例

IBackgroundCopyFile::GetLocalName メソッドのサンプルコードを参照してください。

ファイルのローカル名を取得します。

このメソッドは、成功した場合は S_OK を返し、エラーの場合は標準的な COM の HRESULT 値のいずれかを返します。

ローカルファイル名は、 IBackgroundCopyJob インターフェイスの AddFile メソッドまたは AddFileSet メソッドを呼び出したときに設定されます。

例

次の例は、 IBackgroundCopyFile インターフェイスからローカルファイル名とリモートファイル名、および進行状況に関する情報を取得する方法を示しています。この例では、 IBackgroundCopyFile インターフェイスポインターが有効であることを前提としています。

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

ファイル転送の進行状況に関する情報を取得します。

このメソッドは、成功した場合は S_OK を返し、エラーの場合は標準的な COM の HRESULT 値のいずれかを返します。