IVssExamineWriterMetadata::GetExcludeFile メソッド (vsbackup.h)
GetExcludeFile メソッドは、特定のライターのバックアップから明示的に除外されたファイルに関する情報を取得します。
構文
HRESULT GetExcludeFile(
[in] UINT iFile,
[out] IVssWMFiledesc **ppFiledesc
);
パラメーター
[in] iFile
除外されたファイル セットのインデックス。 このパラメーターの値は、0 から n から 1 までの整数です。 ここで、n は、特定のライターのコンポーネントから明示的に除外されたファイル セットの合計数です。 n の値は、IVssExamineWriterMetadata::GetFileCounts によって返されます。
[out] ppFiledesc
ファイル要素情報を含む IVssWMFiledesc オブジェクトへの二重間接ポインター。
戻り値
このメソッドの有効なリターン コードを次に示します。
値 | 説明 |
---|---|
|
IVssWMFiledesc インターフェイスへのポインターが正常に返されました。 |
|
パラメーター値の 1 つが無効です。 |
|
呼び出し元がメモリ不足またはその他のシステム リソースです。 |
|
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。 |
|
除外に指定されたファイル セットが存在しません。 |
|
予期しないエラー。 エラー コードはエラー ログ ファイルに記録されます。 詳細については、「 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 |