IVssCreateWriterMetadata::AddExcludeFiles メソッド (vswriter.h)

  • [アーティクル]

AddExcludeFiles メソッドは、現在のライターのコンポーネントがバックアップされるときに暗黙的に含まれる可能性があるファイル セット (指定されたファイル) を明示的に除外するために使用されます。

構文

HRESULT AddExcludeFiles(
  [in] LPCWSTR wszPath,
  [in] LPCWSTR wszFilespec,
  [in] bool    bRecursive
);

パラメーター

[in] wszPath

ファイルを除外するルート ディレクトリを含む null で終わるワイド文字列へのポインター。

ディレクトリは VSS マシン上のローカル ディレクトリにすることも、リモート ファイル サーバー上のファイル共有ディレクトリにすることもできます。

UNC パスがサポートされています。

パスには環境変数 (%SystemRoot%) を含めることができますが、ワイルドカード文字を含めることはできません。

パスが円記号 ("") で終わるという要件はありません。 この情報を取得するのはアプリケーションによってチェック。

[in] wszFilespec

除外するファイルのファイル指定を含む null で終わるワイド文字列へのポインター。

ファイル指定にディレクトリ指定を含めることはできません (たとえば、バックスラッシュは含めません)、 を含めることができます。 および * ワイルドカード文字。

[in] bRecursive

wszPath パラメーターで指定されたパスが 1 つのディレクトリのみを識別するか、再帰的に走査するディレクトリの階層を示すかを指定するブール値。 パスが繰り返し実行されるディレクトリの階層として扱われる場合は true 、それ以外の場合は false に設定する必要があります。

マウントされたフォルダーの走査の詳細については、「マウント されたフォルダーの操作」と「ポイントの再解析」を参照してください。

戻り値

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

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

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

解説

Windows 7、Windows Server 2008 R2、Windows Vista、Windows Server 2008、Windows XP、Windows Server 2003: リモート ファイル共有は、Windows 8 と Windows Server 2012 まではサポートされません。 ライターはローカル リソースのみをサポートします。絶対パスが有効なローカル ボリューム仕様で始まり、マップされたネットワーク ドライブにすることはできません。 したがって、(環境変数の解決後に) AddExcludeFiles へのパス入力 (wszPath) は、この形式である必要があります。

たとえば、特定のディレクトリ内のすべてのファイルを含めるコンポーネントを定義し、 AddExcludeFiles を使用して一部のファイル (一時ファイルなど) をバックアップから明示的に削除すると便利です。

ファイルの除外の詳細については、「ファイル 一覧の指定を除外する」を参照してください。

要件

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

関連項目

IVssCreateWriterMetadata

IVssCreateWriterMetadata::AddComponent