IVssWMComponent::GetFile メソッド (vsbackup.h)

  • [アーティクル]

GetFile メソッドは、ファイル グループに関連付けられているファイル記述子を取得します。

構文

HRESULT GetFile(
  [in]  UINT           iFile,
  [out] IVssWMFiledesc **ppFiledesc
);

パラメーター

[in] iFile

0 ~ n-1 の間のオフセット。n は、IVssWMComponent::GetComponentInfo によって返されるVSS_COMPONENTINFO オブジェクトの cFileCount メンバーによって指定されたファイル グループ内のファイルの数です。

[out] ppFiledesc

返されたファイル記述子情報を含む IVssWMFiledesc オブジェクトへの二重間接ポインター。

戻り値

このメソッドの有効なリターン コードを次に示します。

値 説明
S_OK
 IVssWMFiledesc インターフェイスのインスタンスへのポインターが正常に返されました。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT
 XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
VSS_E_OBJECT_NOT_FOUND
 指定したファイルが存在しません。
VSS_E_UNEXPECTED
 予期しないエラー。 エラー コードは、エラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2008 R2 と Windows 7 まではサポートされません。 代わりに E_UNEXPECTED が使用されます。

解説

呼び出し元は、 IUnknown::Release を呼び出して、返された IVssWMFiledesc オブジェクトによって保持されているシステム リソースを解放します。

要件

   
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー vsbackup.h (VsBackup.h、Vss.h、VsWriter.h を含む)
Library VssApi.lib

関連項目

IVssWMComponent