ホーム › Storage.Vss › IVssCreateWriterMetadata

IVssCreateWriterMetadata

COM

自前メソッド開始 vtbl0

公式ドキュメント

IVssCreateWriterMetadata インターフェイスは、Identify イベントに応じて Writer Metadata Document を構築するためのメソッドを含む C++(COM ではない)インターフェイスです。CVssWriter::OnIdentify メソッド内でのみ使用されます。

メソッド 12

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 0 HRESULT AddIncludeFiles(LPWSTR wszPath, LPWSTR wszFilespec, BYTE bRecursive, LPWSTR wszAlternateLocation)

サポートされていません。(IVssCreateWriterMetadata.AddIncludeFiles)

wszPath	LPWSTR	in	このパラメーターはシステムで使用するために予約されています。
wszFilespec	LPWSTR	in	このパラメーターはシステムで使用するために予約されています。
bRecursive	BYTE	in	このパラメーターはシステムで使用するために予約されています。
wszAlternateLocation	LPWSTR	in	このパラメーターはシステムで使用するために予約されています。

戻り値

このメソッドは値を返しません。

vtbl 1 HRESULT AddExcludeFiles(LPWSTR wszPath, LPWSTR wszFilespec, BYTE bRecursive)

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

wszPath

LPWSTR

除外するファイルが置かれるルートディレクトリを格納した、null 終端のワイド文字列へのポインター。

ディレクトリは VSS マシン上のローカルディレクトリでも、リモートファイルサーバー上のファイル共有ディレクトリでもかまいません。

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

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

パスがバックスラッシュ("")で終わる必要はありません。この情報を取得するアプリケーション側で確認してください。

wszFilespec

LPWSTR

除外するファイルのファイル指定を格納した、null 終端のワイド文字列へのポインター。

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

bRecursive

BYTE

wszPath パラメーターで指定したパスが単一のディレクトリのみを示すのか、再帰的にたどるディレクトリ階層を示すのかを指定するブール値。パスを再帰的にたどるディレクトリ階層として扱う場合は true を、そうでない場合は false を設定します。

マウントされたフォルダーのたどり方については、マウントされたフォルダーと再解析ポイントの操作を参照してください。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	操作は成功しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
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 が使用されます。

解説(Remarks)

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

たとえば、あるディレクトリ内のすべてのファイルを含むようにコンポーネントを定義したうえで、AddExcludeFiles を使用して一部のファイル(たとえば一時ファイル)をバックアップから明示的に除外すると便利な場合がよくあります。

ファイルの除外について詳しくは、除外ファイルリストの指定を参照してください。

vtbl 2 HRESULT AddComponent(VSS_COMPONENT_TYPE ct, LPWSTR wszLogicalPath, LPWSTR wszComponentName, LPWSTR wszCaption, BYTE* pbIcon, DWORD cbIcon, BYTE bRestoreMetadata, BYTE bNotifyOnBackupComplete, BYTE bSelectable, BYTE bSelectableForRestore, DWORD dwComponentFlags)

AddComponent メソッドは、バックアップ対象のコンポーネントとしてデータベースまたはファイルグループを追加します。

ct	VSS_COMPONENT_TYPE	in	コンポーネントの種類を指定する VSS_COMPONENT_TYPE 列挙値。 Windows Server 2003、Windows XP: Windows Server 2003 SP1 より前では、このパラメーターはシステムで使用するために予約されており、呼び出し元は既定値を上書きしないでください。
wszLogicalPath	LPWSTR	in	データベースまたはファイルグループの論理パスを格納した、null 終端のワイド文字列へのポインター。詳しくは、コンポーネントの論理パスを参照してください。論理パスは省略可能で、NULL にできます。
wszComponentName	LPWSTR	in	コンポーネントの名前を格納した、null 終端のワイド文字列へのポインター。この文字列はローカライズされません。このパラメーターは必須で、NULL にはできません。文字列にバックスラッシュを含めることはできません。
wszCaption	LPWSTR	in	コンポーネントの説明("フレンドリ名" とも呼ばれます)を格納した、null 終端のワイド文字列へのポインター。この文字列はローカライズされる場合があるため、リクエスターはローカライズされているものとして扱う必要があります。このパラメーターは省略可能で、NULL にできます。文字列にバックスラッシュを含めることができます。
pbIcon	BYTE*	in	ユーザーインターフェイスに表示される、データベースを表すアイコンのビットマップへのポインター。バッファーのサイズ(バイト単位)は cbIcon パラメーターで指定します。ライターがアイコンを指定しない場合は、pbIcon を NULL に設定します。
cbIcon	DWORD	in	バッファーのサイズ(バイト単位)。pbIcon パラメーターが NULL の場合、cbIcon は 0 にします。
bRestoreMetadata	BYTE	in	このパラメーターは将来使用するために予約されており、常に false に設定してください。
bNotifyOnBackupComplete	BYTE	in	このパラメーターは将来使用するために予約されており、常に false に設定してください。
bSelectable	BYTE	in	コンポーネントを任意にバックアップできる(つまりバックアップから除外できる)か、ライターのいずれかのコンポーネントがバックアップされるときに常にバックアップされるかを示すブール値。コンポーネントを選択的にバックアップできる場合は true、いずれかのコンポーネントがバックアップされるときにバックアップされる場合は false です。
bSelectableForRestore	BYTE	in	コンポーネントがバックアップドキュメントに明示的に含められていない場合に、そのコンポーネントを個別に復元できるかどうかを決定するブール値。コンポーネントがバックアップドキュメントに明示的に追加されている場合は、常に個別に復元対象として選択できます。この場合、このフラグに意味はありません。 true の場合、コンポーネントは単独で復元できます。false の場合、コンポーネントはコンポーネントセット全体が復元される場合にのみ復元できます。(詳しくは、VSS_COMPONENTINFO および選択可能性と論理パスの操作を参照してください)。このパラメーターの既定値は false です。
dwComponentFlags	DWORD	in	このコンポーネントがサポートする機能を示す、VSS_COMPONENT_FLAGS 列挙のメンバーのビットマスク(またはビットごとの OR)。この引数の既定値は 0 です。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	操作は成功しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細はイベントログを確認してください。詳しくは、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_OBJECT_ALREADY_EXISTS	オブジェクトが重複しています。同じ論理パスとコンポーネント名を持つコンポーネントが既に存在します。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳しくは、VSS におけるイベントとエラーの処理を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は Windows Server 2008 R2 および Windows 7 まではサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

このメソッドを複数回呼び出して、ライターのメタデータに複数のコンポーネントを追加できます。

特定のクラスのライターの特定のインスタンスにおける各コンポーネントの論理パスと名前の組み合わせは、一意でなければなりません。同じ wszLogicalPath と wszComponentName の値で AddComponent を 2 回呼び出そうとすると、VSS_E_OBJECT_ALREADY_EXISTS エラーになります。

AddComponent は、サブコンポーネント(すべてのメンバーファイルがグループとしてバックアップされるが、個別に復元できるファイルを含むコンポーネント)を追加するために使用できます。詳しくは、復元の選択可能性とサブコンポーネントの操作を参照してください。

vtbl 3 HRESULT AddDatabaseFiles(LPWSTR wszLogicalPath, LPWSTR wszDatabaseName, LPWSTR wszPath, LPWSTR wszFilespec, DWORD dwBackupTypeMask)

AddDatabaseFiles メソッドは、バックアップ対象のデータベースコンポーネントを構成するファイルセット(指定した 1 つまたは複数のファイル)を示します。

wszLogicalPath	LPWSTR	in	データベースを追加するコンポーネントの論理パスを格納した、null 終端のワイド文字列へのポインター。詳しくは、コンポーネントの論理パスを参照してください。論理パスは必須ではなく、NULL にできます。
wszDatabaseName	LPWSTR	in	データベースの名前を格納した、null 終端のワイド文字列へのポインター。この名前は必須で、データベースを追加するコンポーネントの名前と一致している必要があります。
wszPath	LPWSTR	in	データベースファイルが置かれているディレクトリのパスを格納した、null 終端のワイド文字列へのポインター。パスには環境変数(例: %SystemRoot%)を含めることができますが、ワイルドカード文字を含めることはできません。 UNC パスがサポートされます。パスがバックスラッシュ("")で終わる必要はありません。この情報を取得するアプリケーション側で確認してください。
wszFilespec	LPWSTR	in	データベースに関連付けられた 1 つまたは複数のファイルのファイル指定を格納した、null 終端のワイド文字列へのポインター。ファイル指定にディレクトリ指定を含めることはできません(例: バックスラッシュは使用不可)が、? および * のワイルドカード文字を含めることはできます。
dwBackupTypeMask	DWORD	in	ライターが特定の種類のバックアップ操作への参加についてファイルを評価すべきかどうかを示す、VSS_FILE_SPEC_BACKUP_TYPE 列挙値のビットマスク(またはビットごとの OR)。この引数の既定値は (VSS_FSBT_ALL_BACKUP_REQUIRED \| VSS_FSBT_ALL_SNAPSHOT_REQUIRED) です。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	操作は成功しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
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 が使用されます。

解説(Remarks)

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

このメソッドは、特定のデータベースに対して複数回呼び出すことができます。これは、Microsoft SQL Server で可能なように、データベースが別々のボリュームに格納されたファイル上に存在する場合に行います。

wszLogicalPath および wszDatabaseName パラメーターの値は、IVssCreateWriterMetadata::AddComponent メソッドで以前に追加したデータベースコンポーネントのいずれかの値と一致している必要があります。

vtbl 4 HRESULT AddDatabaseLogFiles(LPWSTR wszLogicalPath, LPWSTR wszDatabaseName, LPWSTR wszPath, LPWSTR wszFilespec, DWORD dwBackupTypeMask)

AddDatabaseLogFiles メソッドは、バックアップ対象のデータベースに関連付けられたログファイルと、その場所を示します。

wszLogicalPath	LPWSTR	in	ログファイルを追加するデータベースコンポーネントの論理パスを格納した、null 終端のワイド文字列へのポインター。詳しくは、コンポーネントの論理パスを参照してください。論理パスは必須ではなく、NULL にできます。
wszDatabaseName	LPWSTR	in	ログファイルに関連付けられたデータベースコンポーネントの名前を格納した、null 終端のワイド文字列へのポインター。このコンポーネントの種類は VSS_CT_DATABASE でなければなりません。そうでない場合、メソッドはエラーを返します。
wszPath	LPWSTR	in	ログファイルが置かれているディレクトリのパスを格納した、null 終端のワイド文字列へのポインター。ディレクトリは VSS マシン上のローカルディレクトリでも、リモートファイルサーバー上のファイル共有ディレクトリでもかまいません。 UNC パスがサポートされます。パスには環境変数(例: %SystemRoot%)を含めることができますが、ワイルドカード文字を含めることはできません。パスがバックスラッシュ("")で終わる必要はありません。この情報を取得するアプリケーション側で確認してください。
wszFilespec	LPWSTR	in	データベースに関連付けられたログファイルのファイル指定を格納した、null 終端のワイド文字列へのポインター。ファイル指定にディレクトリ指定を含めることはできません(例: バックスラッシュは使用不可)が、? および * のワイルドカード文字を含めることはできます。
dwBackupTypeMask	DWORD	in	ライターが特定の種類のバックアップ操作への参加についてファイルを評価すべきかどうかを示す、VSS_FILE_SPEC_BACKUP_TYPE 列挙値のビットマスク(またはビットごとの OR)。この引数の既定値は (VSS_FSBT_ALL_BACKUP_REQUIRED \| VSS_FSBT_ALL_SNAPSHOT_REQUIRED) です。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	操作は成功しました。
E_INVALIDARG	いずれかのパラメーター値が無効であるか、非データベースコンポーネントにデータベースファイルを追加しようとしました。
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 が使用されます。

解説(Remarks)

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

このメソッドは、特定のデータベースコンポーネントに対して複数回呼び出すことができます。これは、複数のログファイルが別々のボリュームに格納されている場合に必要になることがあります。

vtbl 5 HRESULT AddFilesToFileGroup(LPWSTR wszLogicalPath, LPWSTR wszGroupName, LPWSTR wszPath, LPWSTR wszFilespec, BYTE bRecursive, LPWSTR wszAlternateLocation, DWORD dwBackupTypeMask)

AddFilesToFileGroup メソッドは、指定したファイルグループコンポーネントにファイルセット(指定した 1 つまたは複数のファイル)を追加します。

wszLogicalPath	LPWSTR	in	ファイルを追加するコンポーネントの論理パス(NULL でもかまいません)を格納した、null 終端のワイド文字列へのポインター。詳しくは、コンポーネントの論理パスを参照してください。
wszGroupName	LPWSTR	in	ファイルグループコンポーネントの名前を格納した、null 終端のワイド文字列へのポインター。このコンポーネントの種類は VSS_CT_FILEGROUP でなければなりません。そうでない場合、メソッドはエラーを返します。
wszPath	LPWSTR	in	追加するファイルの既定のルートディレクトリを格納した、null 終端のワイド文字列へのポインター。ディレクトリは VSS マシン上のローカルディレクトリでも、リモートファイルサーバー上のファイル共有ディレクトリでもかまいません。 UNC パスがサポートされます。パスには環境変数(例: %SystemRoot%)を含めることができますが、ワイルドカード文字を含めることはできません。パスがバックスラッシュ("")で終わる必要はありません。この情報を取得するアプリケーション側で確認してください。
wszFilespec	LPWSTR	in	含めるファイルのファイル指定を格納した、null 終端のワイド文字列へのポインター。ファイル指定にディレクトリ指定を含めることはできません(例: バックスラッシュは使用不可)が、? および * のワイルドカード文字を含めることはできます。
bRecursive	BYTE	in	wszPath パラメーターで指定したパスが単一のディレクトリのみを示すのか、再帰的にたどるディレクトリ階層を示すのかを指定するブール値。パスを再帰的にたどるディレクトリ階層として扱う場合は true を、そうでない場合は false を設定します。マウントされたフォルダーのたどり方については、マウントされたフォルダーと再解析ポイントの操作を参照してください。
wszAlternateLocation	LPWSTR	in	このコンポーネントでバックアップするファイルが実際に置かれている代替パスを格納した、null 終端のワイド文字列へのポインター。ディレクトリは VSS マシン上のローカルディレクトリでも、リモートファイルサーバー上のファイル共有ディレクトリでもかまいません。 UNC パスがサポートされます。代替パスの指定は省略可能です。代替パスが不要な場合は、wszAlternatePath を NULL にします。代替パスは代替場所マッピングと混同しないでください。
dwBackupTypeMask	DWORD	in	ライターが特定の種類のバックアップ操作への参加についてファイルを評価すべきかどうかを示す、VSS_FILE_SPEC_BACKUP_TYPE 列挙値のビットマスク。この引数の既定値は (VSS_FSBT_ALL_BACKUP_REQUIRED \| VSS_FSBT_ALL_SNAPSHOT_REQUIRED) です。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK 0x00000000L	操作は成功しました。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効であるか、非ファイルグループコンポーネントにファイルグループのファイルを追加しようとしました。
E_OUTOFMEMORY 0x8007000EL	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT 0x80042311L	XML ドキュメントが無効です。詳細はイベントログを確認してください。詳しくは、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_NOT_SUPPORTED 0x8004232FL	エクスプレスライターの場合、wszAlternatePath の値は NULL でなければならず、dwBackupTypeMask ビットマスクに VSS_FSBT_DIFFERENTIAL_BACKUP_REQUIRED、VSS_FSBT_INCREMENTAL_BACKUP_REQUIRED、VSS_FSBT_LOG_BACKUP_REQUIRED を含めることはできません。
VSS_E_OBJECT_NOT_FOUND 0x80042308L	指定されたコンポーネントは存在しません。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳しくは、VSS におけるイベントとエラーの処理を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は Windows Server 2008 R2 および Windows 7 まではサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

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

ライターはこのメソッドを複数回呼び出して、ファイルグループコンポーネントに複数のファイルセットを追加できます。ただし、特定のファイルは 1 回だけ指定できるため、ファイル指定が重複しないようにする必要があります。

ファイルのバックアップ元および復元先の場所は、wszPath で定義されたルートディレクトリと wszAlternatePath で定義された代替パスの値によって決まります。

AddFilesToFileGroup によって提供されるパス情報を使用する際は、次の点に注意してください。

復元操作では、(可能であれば)AddFilesToFileGroup によってコンポーネントに追加されたファイルを、wszPath で定義された既定のルートディレクトリの下に復元する必要があります。
代替パスが指定されていない場合(wszAlternatePath が NULL の場合)、コンポーネントに追加されたファイルは既定のルートディレクトリからバックアップされ、wszPath で示される既定のルートディレクトリに復元されます。
代替パスが指定されている場合(wszAlternatePath が非 NULL の場合)、コンポーネントに追加されたファイルは wszAlternatePath で指定された代替パスからバックアップされます。ただし、リクエスターは既定の復元先として引き続き wszPath を使用します。
代替パスが定義されており(wszAlternatePath が非 NULL)、ファイル指定(wszFilespec)に一致するファイルが代替パスと既定のルートディレクトリ(wszPath)の両方に存在する場合、バックアップ操作では既定のルートディレクトリの下にあるファイルではなく、代替パスの下にあるファイルをバックアップする必要があります。
IVssCreateWriterMetadata::AddAlternateLocationMapping によって代替場所マッピングが設定され、復元方法または復元ターゲットがそれを必要とする場合を除き、ファイルは wszPath で示されるディレクトリに復元する必要があります。

VSS におけるバックアップおよび復元のファイルの場所について詳しくは、既定以外のバックアップおよび復元の場所を参照してください。

vtbl 6 HRESULT SetRestoreMethod(VSS_RESTOREMETHOD_ENUM method, LPWSTR wszService, LPWSTR wszUserProcedure, VSS_WRITERRESTORE_ENUM writerRestore, BYTE bRebootRequired)

SetRestoreMethod メソッドは、ライターのデータをどのように復元するかを示します。

method	VSS_RESTOREMETHOD_ENUM	in	復元操作で使用される方法を指定する VSS_RESTOREMETHOD_ENUM 値。
wszService	LPWSTR	in	method の値が VSS_RME_STOP_RESTORE_START または VSS_RME_RESTORE_STOP_START の場合に、復元操作の前に停止し、復元操作の後に開始する必要があるサービスの名前を格納した、ワイド文字列へのポインター。 method の値が VSS_RME_STOP_RESTORE_START でも VSS_RME_RESTORE_STOP_START でもない場合、この引数は使用されず、NULL に設定する必要があります。
wszUserProcedure	LPWSTR	in	将来使用するために予約されています。このパラメーターの値は常に NULL に設定してください。
writerRestore	VSS_WRITERRESTORE_ENUM	in	ライターが自身のデータの復元に関与するかどうかを指定する VSS_WRITERRESTORE_ENUM 値。エクスプレスライターは、このパラメーターを VSS_WRE_NEVER に設定する必要があります。
bRebootRequired	BYTE	in	復元操作の完了後に再起動が必要かどうかを示すブール値。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK 0x00000000L	操作は成功しました。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY 0x8007000EL	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT 0x80042311L	XML ドキュメントが無効です。詳細はイベントログを確認してください。詳しくは、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_NOT_SUPPORTED 0x8004232FL	呼び出し元が、エクスプレスライターではサポートされない VSS_WRITERRESTORE_ENUM 値を指定しました。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳しくは、VSS におけるイベントとエラーの処理を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は Windows Server 2008 R2 および Windows 7 まではサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

ライターに対して定義される復元方法は 1 つです。復元方法が上書きされない場合、ライターのすべてのコンポーネントは同じ方法で復元されます。

ライターは、通常 PreRestore イベント(CVssWriter::OnPreRestore)の処理中に復元ターゲットを設定することで、コンポーネントごとに復元方法を上書きします。

復元方法はライター全体に適用されますが、実際にはコンポーネントごとに実装される点に注意することが重要です。たとえば、method パラメーターで指定された方法が VSS_RME_RESTORE_IF_CAN_REPLACE の場合、コンポーネント内のすべてのファイルは、エラーを発生させずにすべて置き換えられる場合に元の場所に復元されます。そうでない場合は、代替場所が指定されていればそこに復元されます。

次のいずれかに該当する場合、ファイルは常にその代替場所マッピングに復元する必要があります。

(バックアップ時に設定された)復元方法が VSS_RME_RESTORE_TO_ALTERNATE_LOCATION である。
(復元時に)その復元ターゲットが VSS_RT_ALTERNATE に設定された。

いずれの場合も、有効な代替場所マッピングが定義されていない場合は、ライターエラーとなります。

次のいずれかに該当する場合、ファイルを代替場所マッピングに復元できます。

復元方法が VSS_RME_RESTORE_IF_NOT_THERE であり、ファイルのバージョンが既にディスク上に存在する。
復元方法が VSS_RME_RESTORE_IF_CAN_REPLACE であり、ファイルのバージョンがディスク上に存在し、置き換えられない。

この場合も、有効な代替場所マッピングが定義されていない場合は、ライターエラーとなります。

代替場所マッピングは復元操作中にのみ使用され、バックアップ操作中にのみ使用される代替パスと混同しないでください。

復元方法について詳しくは、VSS 復元方法の設定を参照してください。

復元方法が VSS_RME_STOP_RESTORE_START または VSS_RME_RESTORE_STOP_START の場合、正しいサービス名を wszService 引数として指定する必要があります。復元操作中のサービスの停止と再起動へのライターの関与については、リクエスターによる復元のためのサービス停止を参照してください。

vtbl 7 HRESULT AddAlternateLocationMapping(LPWSTR wszSourcePath, LPWSTR wszSourceFilespec, BYTE bRecursive, LPWSTR wszDestination)

AddAlternateLocationMapping メソッドは、ファイルセットの代替場所マッピングを作成します。

wszSourcePath	LPWSTR	in	マッピングするファイルが置かれているディレクトリまたはディレクトリ階層の名前を格納した、null 終端のワイド文字列。ディレクトリは VSS マシン上のローカルディレクトリでも、リモートファイルサーバー上のファイル共有ディレクトリでもかまいません。パスには環境変数(例: %SystemRoot%)を含めることができますが、ワイルドカード文字を含めることはできません。パスがバックスラッシュ("")で終わる必要はありません。この情報を取得するアプリケーション側で確認してください。
wszSourceFilespec	LPWSTR	in	マッピングするファイルのファイル指定を格納した、null 終端のワイド文字列。ファイル指定にディレクトリ指定を含めることはできません(例: バックスラッシュは使用不可)が、? および * のワイルドカード文字を含めることはできます。
bRecursive	BYTE	in	wszPath パラメーターで指定したパスが単一のディレクトリのみを示すのか、再帰的にたどるディレクトリ階層を示すのかを指定するブール値。パスを再帰的にたどるディレクトリ階層として扱う場合は true を、そうでない場合は false を設定します。マウントされたフォルダーのたどり方については、マウントされたフォルダーと再解析ポイントの操作を参照してください。
wszDestination	LPWSTR	in	ファイルの再配置先ディレクトリへの完全修飾パスを格納した、null 終端のワイド文字列。ディレクトリは VSS マシン上のローカルディレクトリでも、リモートファイルサーバー上のファイル共有ディレクトリでもかまいません。 UNC パスがサポートされます。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK 0x00000000L	操作は成功しました。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY 0x8007000EL	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT 0x80042311L	XML ドキュメントが無効です。詳細はイベントログを確認してください。詳しくは、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_OBJECT_NOT_FOUND 0x80042308L	IVssCreateWriterMetadata::SetRestoreMethod メソッドがこのメソッドの前に呼び出されませんでした。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳しくは、VSS におけるイベントとエラーの処理を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は Windows Server 2008 R2 および Windows 7 まではサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

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

このメソッドを複数回呼び出して、複数のファイルのマッピングを追加できます。

AddAlternateLocationMapping に渡すマッピング対象のパス、ファイル指定、再帰フラグの組み合わせ(それぞれ wszPath、wszFileSpec、bRecursive)は、IVssCreateWriterMetadata::AddFilesToFileGroup、IVssCreateWriterMetadata::AddDatabaseFiles、または IVssCreateWriterMetadata::AddDatabaseLogFiles を使用してライターのいずれかのコンポーネントに追加されたファイルセットのいずれかと一致している必要があります。

AddAlternateLocationMapping メソッドは、IVssCreateWriterMetadata::SetRestoreMethod が呼び出された後にのみ呼び出す必要があります。

次のいずれかに該当する場合、ファイルは常にその代替場所マッピングに復元する必要があります。

(バックアップ時に設定された)復元方法が VSS_RME_RESTORE_TO_ALTERNATE_LOCATION である。
(復元時に)その復元ターゲットが VSS_RT_ALTERNATE に設定された。

いずれの場合も、有効な代替場所マッピングが定義されていない場合は、ライターエラーとなります。

次のいずれかに該当する場合、ファイルを代替場所マッピングに復元できます。

復元方法が VSS_RME_RESTORE_IF_NOT_THERE であり、ファイルのバージョンが既にディスク上に存在する。
復元方法が VSS_RME_RESTORE_IF_CAN_REPLACE であり、ファイルのバージョンがディスク上に存在し、置き換えられない。

この場合も、有効な代替場所マッピングが定義されていない場合は、ライターエラーとなります。

代替場所マッピングは復元操作中にのみ使用され、バックアップ操作中にのみ使用される代替パスと混同しないでください。

VSS におけるバックアップおよび復元のファイルの場所について詳しくは、既定以外のバックアップおよび復元の場所を参照してください。

vtbl 8 HRESULT AddComponentDependency(LPWSTR wszForLogicalPath, LPWSTR wszForComponentName, GUID onWriterId, LPWSTR wszOnLogicalPath, LPWSTR wszOnComponentName)

AddComponentDependency メソッドを使用すると、ライターは、自身が管理するコンポーネントに明示的なライターコンポーネント依存関係があること、つまり別のライター内の別のコンポーネントをそのコンポーネントと一緒にバックアップおよび復元する必要があることを示すことができます。

wszForLogicalPath	LPWSTR	in	依存関係を必要とする(現在のライターが管理する)コンポーネントの論理パスを格納した、null 終端のワイド文字列。
wszForComponentName	LPWSTR	in	依存関係を必要とする(現在のライターが管理する)コンポーネントを格納した、null 終端のワイド文字列。
onWriterId	GUID	in	現在のコンポーネントが依存するコンポーネントを管理するライターのクラス ID または VSS_ID(GUID)。
wszOnLogicalPath	LPWSTR	in	現在のコンポーネントが依存する(onWriterId で識別されるライターが管理する)コンポーネントの論理パス。
wszOnComponentName	LPWSTR	in	現在のコンポーネントが依存する(onWriterId で識別されるライターが管理する)コンポーネントの名前。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	操作は成功しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細はイベントログを確認してください。詳しくは、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_OBJECT_NOT_FOUND	wszForLogicalPath および wszForComponentName で指定されたコンポーネントは存在しません。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳しくは、VSS におけるイベントとエラーの処理を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は Windows Server 2008 R2 および Windows 7 まではサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

現在のライターが管理するコンポーネントへの依存関係は許可されません。

依存関係では、依存関係のターゲットと、そのターゲットに依存するコンポーネントの両方を、一緒に復元およびバックアップする必要があります。これはコンポーネント間の優先順位を示すものではありませんが、リクエスターがそれを実装することを選択する場合があります。

論理名とコンポーネント名の組み合わせはライタークラスのすべてのインスタンスにわたって一意でなければならないため、複数のライターが同じクラス ID を持つ可能性があっても問題にはなりません。

このメソッドは、リモート依存関係を宣言するために使用できます。ライターは、wszOnLogicalPath パラメーターの論理パスの先頭に "\\RemoteComputerName"(RemoteComputerName はリモートコンポーネントが存在するコンピューターの名前)を付加することで、リモート依存関係を宣言できます。RemoteComputerName の値には、IP アドレス、または GetComputerNameEx 関数によって返されるコンピューター名を指定できます。

リモートコンポーネントがクラスター上に存在する場合、ライターはクラスターの仮想名を報告する必要があり、ボリュームシャドウコピーを作成する前に仮想名をクラスターノードの物理名にマッピングするのはリクエスターの責任です。

依存関係がローカルかリモートかを判断するには、リクエスターは pbstrComponentName パラメーターで返されるコンポーネント名を調べる必要があります。コンポーネント名が "\" で始まる場合、リクエスターはそれがリモート依存関係を指定していること、および "\" に続く最初のコンポーネントがライターによって指定された RemoteComputerName であることを想定する必要があります。コンポーネント名が "\" で始まらない場合、リクエスターはそれがローカル依存関係を指定していると想定する必要があります。

Windows Server 2003: このメソッドは、Windows Server 2003 Service Pack 1 (SP1) までリモート依存関係の宣言に使用できません。

vtbl 9 HRESULT SetBackupSchema(DWORD dwSchemaMask)

SetBackupSchema メソッドは、ライターが参加できるバックアップ操作の種類を、その Writer Metadata Document に示すために使用します。

dwSchemaMask

DWORD

このライターがサポートするバックアップ操作の種類を、VSS_BACKUP_SCHEMA 列挙値のビットマスクとして表したもの。

エクスプレスライターでは、VSS_BS_UNDEFINED、VSS_BS_COPY、VSS_BS_INDEPENDENT_SYSTEM_STATE の値のみがサポートされます。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK 0x00000000L	失敗メッセージの設定に成功しました。
E_INVALIDARG 0x80070057L	バックアップスキーマの引数が無効です。
E_OUTOFMEMORY 0x8007000EL	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT 0x80042311L	XML ドキュメントが無効です。詳細はイベントログを確認してください。詳しくは、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_NOT_SUPPORTED 0x8004232FL	呼び出し元が、エクスプレスライターではサポートされない VSS_BACKUP_SCHEMA 値を指定しました。

解説(Remarks)

SetBackupSchema によってスキーマが明示的に設定されない場合、ライターには既定値の VSS_BS_UNDEFINED が割り当てられます。この場合、ライターは(VSS_BT_FULL で定義される)ファイル全体の単純な完全バックアップと復元のみをサポートし、増分バックアップや差分バックアップはサポートされず、部分ファイルもサポートされません。

リクエスターは、IVssExamineWriterMetadata::GetBackupSchema を呼び出して、SetBackupSchema によって設定されたライターのバックアップスキーマを取得します。

vtbl 10 HRESULT GetDocument(IXMLDOMDocument** pDoc)

サポートされていません。(IVssCreateWriterMetadata.GetDocument)

pDoc

IXMLDOMDocument**

out

このパラメーターはシステムで使用するために予約されています。

戻り値

このメソッドは値を返しません。

vtbl 11 HRESULT SaveAsXML(LPWSTR* pbstrXML)

SaveAsXML メソッドは、ライターの状態情報を含む Writer Metadata Document を、指定した文字列に保存します。

pbstrXML

LPWSTR*

inout

ライターの状態情報を含む Writer Metadata Document を格納するために使用する文字列へのポインター。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	意味
S_OK	操作は成功しました。
E_INVALIDARG	いずれかのパラメーター値が無効です。
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 が使用されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IVssCreateWriterMetadata "{}"
#usecom global IVssCreateWriterMetadata IID_IVssCreateWriterMetadata "{}"
#comfunc global IVssCreateWriterMetadata_AddIncludeFiles              0 wstr,wstr,int,wstr
#comfunc global IVssCreateWriterMetadata_AddExcludeFiles              1 wstr,wstr,int
#comfunc global IVssCreateWriterMetadata_AddComponent                 2 int,wstr,wstr,wstr,var,int,int,int,int,int,int
#comfunc global IVssCreateWriterMetadata_AddDatabaseFiles             3 wstr,wstr,wstr,wstr,int
#comfunc global IVssCreateWriterMetadata_AddDatabaseLogFiles          4 wstr,wstr,wstr,wstr,int
#comfunc global IVssCreateWriterMetadata_AddFilesToFileGroup          5 wstr,wstr,wstr,wstr,int,wstr,int
#comfunc global IVssCreateWriterMetadata_SetRestoreMethod             6 int,wstr,wstr,int,int
#comfunc global IVssCreateWriterMetadata_AddAlternateLocationMapping  7 wstr,wstr,int,wstr
#comfunc global IVssCreateWriterMetadata_AddComponentDependency       8 wstr,wstr,int,wstr,wstr
#comfunc global IVssCreateWriterMetadata_SetBackupSchema              9 int
#comfunc global IVssCreateWriterMetadata_GetDocument                  10 sptr
#comfunc global IVssCreateWriterMetadata_SaveAsXML                    11 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVssCreateWriterMetadata "{}"
#usecom global IVssCreateWriterMetadata IID_IVssCreateWriterMetadata "{}"
#comfunc global IVssCreateWriterMetadata_AddIncludeFiles              0 wstr,wstr,int,wstr
#comfunc global IVssCreateWriterMetadata_AddExcludeFiles              1 wstr,wstr,int
#comfunc global IVssCreateWriterMetadata_AddComponent                 2 int,wstr,wstr,wstr,sptr,int,int,int,int,int,int
#comfunc global IVssCreateWriterMetadata_AddDatabaseFiles             3 wstr,wstr,wstr,wstr,int
#comfunc global IVssCreateWriterMetadata_AddDatabaseLogFiles          4 wstr,wstr,wstr,wstr,int
#comfunc global IVssCreateWriterMetadata_AddFilesToFileGroup          5 wstr,wstr,wstr,wstr,int,wstr,int
#comfunc global IVssCreateWriterMetadata_SetRestoreMethod             6 int,wstr,wstr,int,int
#comfunc global IVssCreateWriterMetadata_AddAlternateLocationMapping  7 wstr,wstr,int,wstr
#comfunc global IVssCreateWriterMetadata_AddComponentDependency       8 wstr,wstr,int,wstr,wstr
#comfunc global IVssCreateWriterMetadata_SetBackupSchema              9 int
#comfunc global IVssCreateWriterMetadata_GetDocument                  10 sptr
#comfunc global IVssCreateWriterMetadata_SaveAsXML                    11 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。