Win32 API 日本語リファレンス
ホームStorage.Vss › IVssCreateExpressWriterMetadata

IVssCreateExpressWriterMetadata

COM
IID9c772e77-b26e-427f-92dd-c996f41ea5e3継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVssCreateExpressWriterMetadata インターフェイスは、エクスプレスライター用の Writer Metadata Document を構築するためのメソッドを含む COM インターフェイスです。

メソッド 7

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

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

エクスプレスライターのコンポーネントがバックアップされる際に暗黙的に含まれてしまう可能性のあるファイルセット(指定された1つまたは複数のファイル)を除外します。

wszPathLPWSTRin

除外するファイルの起点となるルートディレクトリを格納した、null で終わるワイド文字列へのポインター。

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

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

wszFilespecLPWSTRin

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

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

bRecursiveBYTEin

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

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

戻り値

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

Value Meaning
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)

エクスプレスライターがサポートするのはローカルリソース、すなわち絶対パスが有効なローカルボリューム指定で始まるファイルセットのみであり、マップされたネットワークドライブは使用できません。したがって、AddExcludeFiles に渡すパス入力(wszPath)は(環境変数の解決後に)この形式である必要があります。たとえば、指定したディレクトリ内のすべてのファイルを含むコンポーネントを定義したうえで、AddExcludeFiles を使用して一部のファイル(たとえば一時ファイル)をバックアップから明示的に除外すると便利なことがよくあります。

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

vtbl 4 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)

バックアップ対象となるエクスプレスライターのコンポーネントセットにファイルグループを追加します。

ctVSS_COMPONENT_TYPEinコンポーネントの種類を指定する VSS_COMPONENT_TYPE 列挙値。このパラメーターでは VSS_CT_FILEGROUP のみがサポートされます。
wszLogicalPathLPWSTRin

データベースまたはファイルグループの論理パスを格納した、null で終わるワイド文字列へのポインター。詳細については、コンポーネントの論理パスを参照してください。

このパラメーターは省略可能で、NULL にできます。

wszComponentNameLPWSTRin

コンポーネントの名前を格納した、null で終わるワイド文字列へのポインター。この文字列はローカライズされません。

このパラメーターは必須で、NULL にはできません。文字列にバックスラッシュを含めることはできません。

wszCaptionLPWSTRin

コンポーネントの説明(「フレンドリ名」とも呼ばれる)を格納した、null で終わるワイド文字列へのポインター。この文字列はローカライズされている場合があるため、リクエスターはローカライズされているものとして扱う必要があります。

このパラメーターは省略可能で、NULL にできます。文字列にバックスラッシュを含めることができます。

pbIconBYTE*in

ユーザーインターフェイスに表示する、データベースを表すアイコンのビットマップへのポインター。バッファーのサイズ(バイト単位)は cbIcon パラメーターで指定します。

このパラメーターは省略可能で、NULL にできます。

cbIconDWORDinバッファーのサイズ(バイト単位)。pbIcon パラメーターが NULL の場合、cbIcon は 0 でなければなりません。
bRestoreMetadataBYTEinこのパラメーターは将来の使用のために予約されており、常に false を設定する必要があります。
bNotifyOnBackupCompleteBYTEinこのパラメーターは将来の使用のために予約されており、常に false を設定する必要があります。
bSelectableBYTEinコンポーネントを任意でバックアップできる(つまりバックアップから除外できる)のか、それともライターのいずれかのコンポーネントがバックアップされるときに常にバックアップされるのかを示すブール値。コンポーネントを選択的にバックアップできる場合は true を、いずれかのコンポーネントがバックアップされるときにこのコンポーネントもバックアップされる場合は false を設定します。
bSelectableForRestoreBYTEin

コンポーネントがバックアップドキュメントに明示的に含められていない場合に、そのコンポーネントを個別に復元できるかどうかを決定するブール値。コンポーネントがバックアップドキュメントに明示的に追加されていた場合は、常に個別に復元対象として選択できます。この場合、このフラグには意味がありません。

このパラメーターが true の場合、コンポーネントは単独で復元できます。false の場合、コンポーネントセット全体が復元される場合にのみ復元できます。(詳細については、VSS_COMPONENTINFO および 選択可能性と論理パスの操作を参照してください。)

このパラメーターの既定値は false です。

dwComponentFlagsDWORDin

このコンポーネントがサポートする機能を示す VSS_COMPONENT_FLAGS 列挙値のビットマスク。このビットマスクに VSS_CF_APP_ROLLBACK_RECOVERY または VSS_CF_BACKUP_RECOVERY を含めることはできません。

このパラメーターの既定値は 0 です。

戻り値

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

Value Meaning
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)

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

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

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

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

エクスプレスライターの指定したファイルグループコンポーネントに、ファイルセット(指定された1つまたは複数のファイル)を追加します。

wszLogicalPathLPWSTRinファイルを追加する対象コンポーネントの論理パス(NULL でも可)を格納した、null で終わるワイド文字列へのポインター。詳細については、コンポーネントの論理パスを参照してください。
wszGroupNameLPWSTRinファイルグループコンポーネントの名前を格納した、null で終わるワイド文字列へのポインター。このコンポーネントの種類は VSS_CT_FILEGROUP でなければなりません。そうでない場合、このメソッドはエラーを返します。
wszPathLPWSTRin

追加するファイルの既定のルートディレクトリを格納した、null で終わるワイド文字列へのポインター。

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

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

wszFilespecLPWSTRin

含めるファイルのファイル指定を格納した、null で終わるワイド文字列へのポインター。

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

bRecursiveBYTEin

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

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

wszAlternateLocationLPWSTRinこのパラメーターは予約されており、NULL でなければなりません。
dwBackupTypeMaskDWORDin

ライターが特定の種類のバックアップ操作への参加についてファイルを評価すべきかどうかを示す、VSS_FILE_SPEC_BACKUP_TYPE 列挙値のビットマスク。

このパラメーターに VSS_FSBT_DIFFERENTIAL_BACKUP_REQUIREDVSS_FSBT_INCREMENTAL_BACKUP_REQUIREDVSS_FSBT_LOG_BACKUP_REQUIRED を含めることはできません。

この引数の既定値は (VSS_FSBT_ALL_BACKUP_REQUIRED | VSS_FSBT_ALL_SNAPSHOT_REQUIRED) です。

戻り値

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

Value Meaning
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 が使用されます。

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

エクスプレスライターのデータをどのように復元するかを指定します。

methodVSS_RESTOREMETHOD_ENUMin復元操作で使用する復元方法を指定する VSS_RESTOREMETHOD_ENUM 列挙値。このパラメーターは必須で、VSS_RME_UNDEFINEDVSS_RME_RESTORE_TO_ALTERNATE_LOCATIONVSS_RME_CUSTOM にはできません。
wszServiceLPWSTRin

method の値が VSS_RME_STOP_RESTORE_START または VSS_RME_RESTORE_STOP_START の場合に、復元操作の前に停止し、復元操作の後に開始する必要があるサービスの名前を格納した、ワイド文字列へのポインター。

method の値が VSS_RME_STOP_RESTORE_START または VSS_RME_RESTORE_STOP_START でない場合、このパラメーターは使用されず、NULL を設定する必要があります。

wszUserProcedureLPWSTRin将来の使用のために予約されています。このパラメーターの値は常に NULL を設定する必要があります。
writerRestoreVSS_WRITERRESTORE_ENUMinライターが自身のデータの復元に関与するかどうかを指定する VSS_WRITERRESTORE_ENUM 列挙値。このパラメーターには VSS_WRE_NEVER を設定する必要があります。
bRebootRequiredBYTEin復元操作の完了後に再起動が必要かどうかを示すブール値。

戻り値

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

Value Meaning
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)

エクスプレスライターが定義できる復元方法は 1 つだけです。復元方法がオーバーライドされない場合、エクスプレスライターのすべてのコンポーネントは同じ方法で復元されます。

エクスプレスライターは、通常 PreRestore イベント(CVssWriter::OnPreRestore)の処理中に復元ターゲットを設定することで、コンポーネントごとに復元方法をオーバーライドします。

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

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

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

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

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

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

エクスプレスライターが管理するコンポーネントに明示的なライターコンポーネント依存関係があること、すなわち別のコンポーネント(場合によっては別のライターが管理)を一緒にバックアップおよび復元する必要があることを示せるようにします。

wszForLogicalPathLPWSTRin依存関係を必要とする(エクスプレスライターが管理する)コンポーネントの論理パスを格納した、null で終わるワイド文字列。
wszForComponentNameLPWSTRin依存関係を必要とする(エクスプレスライターが管理する)コンポーネントを格納した、null で終わるワイド文字列。
onWriterIdGUIDin現在のコンポーネントが依存するコンポーネントを管理するエクスプレスライターのライタークラスを指定する、VSS_ID(GUID)値。
wszOnLogicalPathLPWSTRin現在のコンポーネントが依存する、(onWriterId で識別されるエクスプレスライターが管理する)コンポーネントの論理パス。
wszOnComponentNameLPWSTRin現在のコンポーネントが依存する、(onWriterId で識別されるエクスプレスライターが管理する)コンポーネントの名前。

戻り値

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

Value Meaning
S_OK
操作は成功しました。
E_INVALIDARG
パラメーター値のいずれかが無効です。
E_OUTOFMEMORY
呼び出し元がメモリまたはその他のシステムリソースを使い果たしています。
VSS_E_INVALID_XML_DOCUMENT
XML ドキュメントが無効です。詳細はイベントログを確認してください。詳細については、VSS におけるイベントとエラーの処理を参照してください。
VSS_E_OBJECT_NOT_FOUND
wszForLogicalPathwszForComponentName で指定されたコンポーネントが存在しません。
VSS_E_UNEXPECTED
予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳細については、VSS におけるイベントとエラーの処理を参照してください。

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

vtbl 8 HRESULT SetBackupSchema(DWORD dwSchemaMask)

エクスプレスライターが、参加できるバックアップ操作の種類を自身の Writer Metadata Document に示すために使用します。

dwSchemaMaskDWORDinこのライターがサポートするバックアップ操作の種類を指定する、VSS_BACKUP_SCHEMA 列挙値のビットマスク。

戻り値

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

Value Meaning
S_OK
失敗メッセージの設定に成功しました。
E_INVALIDARG
バックアップスキーマ引数が無効です。
E_OUTOFMEMORY
呼び出し元がメモリまたはその他のシステムリソースを使い果たしています。
VSS_E_INVALID_XML_DOCUMENT
XML ドキュメントが無効です。詳細はイベントログを確認してください。詳細については、VSS におけるイベントとエラーの処理を参照してください。

解説(Remarks)

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

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

vtbl 9 HRESULT SaveAsXML(LPWSTR* pbstrXML)

エクスプレスライターの状態情報を含む Writer Metadata Document を、指定した文字列に格納します。

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

戻り値

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

Value Meaning
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_IVssCreateExpressWriterMetadata "{9C772E77-B26E-427F-92DD-C996F41EA5E3}"
#usecom global IVssCreateExpressWriterMetadata IID_IVssCreateExpressWriterMetadata "{}"
#comfunc global IVssCreateExpressWriterMetadata_AddExcludeFiles         3 wstr,wstr,int
#comfunc global IVssCreateExpressWriterMetadata_AddComponent            4 int,wstr,wstr,wstr,var,int,int,int,int,int,int
#comfunc global IVssCreateExpressWriterMetadata_AddFilesToFileGroup     5 wstr,wstr,wstr,wstr,int,wstr,int
#comfunc global IVssCreateExpressWriterMetadata_SetRestoreMethod        6 int,wstr,wstr,int,int
#comfunc global IVssCreateExpressWriterMetadata_AddComponentDependency  7 wstr,wstr,int,wstr,wstr
#comfunc global IVssCreateExpressWriterMetadata_SetBackupSchema         8 int
#comfunc global IVssCreateExpressWriterMetadata_SaveAsXML               9 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。