IBackgroundCopyFile::GetLocalName メソッド (bits.h)

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

構文

HRESULT GetLocalName(
  [out] LPWSTR *pVal
);

パラメーター

[out] pVal

クライアント上のファイルの名前を含む Null で終わる文字列。 名前は完全修飾です。 完了したら、 CoTaskMemFree 関数を呼び出して ppName を 解放します。

戻り値

このメソッドは、成功 した場合は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);

要件

要件	値
サポートされている最小のクライアント	Windows XP
サポートされている最小のサーバー	Windows Server 2003
対象プラットフォーム	Windows
ヘッダー	bits.h
Library	Bits.lib
[DLL]	QmgrPrxy.dll

こちらもご覧ください

IBackgroundCopyFile

IBackgroundCopyFile::GetRemoteName

IBackgroundCopyJob::AddFile

IBackgroundCopyJob::AddFileSet