ホーム › Storage.Vss › IVssDifferentialSoftwareSnapshotMgmt3

IVssDifferentialSoftwareSnapshotMgmt3

COM

IID383f7e71-a4c5-401f-b27f-f826289f8458継承元IVssDifferentialSoftwareSnapshotMgmt2自前メソッド開始 vtbl13

公式ドキュメント

VSS のシャドウコピー保護機能をアプリケーションから利用するためのメソッドを定義します。

解説(Remarks)

管理者権限を持つアプリケーションは、SetVolumeProtectLevel メソッドを使用して、ボリュームおよびそのシャドウコピー記憶域を含む別のボリュームに対してシャドウコピーの保護レベルを指定できます。両方のボリュームには同じ保護レベルを設定してください。指定可能な保護レベルは VSS_PROTECTION_LEVEL 列挙型で定義されています。

ボリュームの保護障害 (protection fault) が発生した場合、アプリケーションは対象ボリュームに対して GetVolumeProtectLevel メソッドを呼び出し、障害の原因を特定する必要があります。

メソッド 5

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

vtbl 13 HRESULT SetVolumeProtectLevel(WORD* pwszVolumeName, VSS_PROTECTION_LEVEL protectionLevel)

元のボリューム、またはシャドウコピー記憶域のボリュームに対して、シャドウコピーの保護レベルを設定します。

pwszVolumeName

WORD*

ボリュームの名前。このパラメーターは必須であり、NULL を指定することはできません。

名前は次のいずれかの形式で指定し、末尾に円記号 (\) を含める必要があります。

マウントされたフォルダーのパス。例: Y:\MountX\
ドライブ文字。例: D:\
\\?\Volume{GUID}\ 形式のボリューム GUID パス (GUID はボリュームを識別します)

protectionLevel

VSS_PROTECTION_LEVEL

シャドウコピーの保護レベルを指定する、VSS_PROTECTION_LEVEL 列挙型の値。

戻り値

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

値	意味
S_OK	シャドウコピーの保護レベルが正常に設定されました。
E_ACCESSDENIED 0x80070005L	呼び出し元が管理者ではありません。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効です。
E_NOTIMPL 0x80000001L	このボリュームのプロバイダーはシャドウコピー保護をサポートしていません。
VSS_E_PROVIDER_VETO 0x80042306L	想定内のプロバイダーエラーが発生しました。エラーコードはイベントログに記録されます。詳細については、Event and Error Handling Under VSS を参照してください。
VSS_E_OBJECT_NOT_FOUND 0x80042308L	指定されたボリュームが見つかりませんでした。

解説(Remarks)

SetVolumeProtectLevel メソッドは、ボリュームの現在のシャドウコピー保護レベルを確認します。ボリュームが障害状態にあり、protectionLevel パラメーターに VSS_PROTECTION_LEVEL_ORIGINAL_VOLUME が指定されている場合、SetVolumeProtectLevel は保護レベルを設定する前にボリュームをディスマウントします。

ボリュームの現在の保護レベルが protectionLevel パラメーターの値と同じ場合、SetVolumeProtectLevel は何も行いません。

protectionLevel パラメーターの値が VSS_PROTECTION_LEVEL_SNAPSHOT の場合、リクエスターは IVssDifferentialSoftwareSnapshotMgmt::AddDiffArea メソッドを使用して、シャドウコピー記憶域 (差分領域) の関連付けを設定する必要があります。

vtbl 14 HRESULT GetVolumeProtectLevel(WORD* pwszVolumeName, VSS_VOLUME_PROTECTION_INFO* protectionLevel)

指定されたボリュームのシャドウコピー保護レベルと状態を取得します。

pwszVolumeName

WORD*

ボリュームの名前。このパラメーターは必須であり、NULL を指定することはできません。

名前は次のいずれかの形式で指定し、末尾に円記号 (\) を含める必要があります。

マウントされたフォルダーのパス。例: Y:\MountX\
ドライブ文字。例: D:\
\\?\Volume{GUID}\ 形式のボリューム GUID パス (GUID はボリュームを識別します)

protectionLevel

VSS_VOLUME_PROTECTION_INFO*

out

ボリュームのシャドウコピー保護レベルに関する情報を格納した VSS_VOLUME_PROTECTION_INFO 構造体を受け取る、呼び出し元が割り当てたバッファーのアドレス。

戻り値

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

値	意味
S_OK	シャドウコピーの保護レベルが正常に照会されました。
E_ACCESSDENIED 0x80070005L	呼び出し元が管理者ではありません。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効です。
E_NOTIMPL 0x80000001L	このボリュームのプロバイダーはシャドウコピー保護をサポートしていません。
VSS_E_PROVIDER_VETO 0x80042306L	想定内のプロバイダーエラーが発生しました。エラーコードはイベントログに記録されます。詳細については、Event and Error Handling Under VSS を参照してください。
VSS_E_OBJECT_NOT_FOUND 0x80042308L	指定されたボリュームが見つかりませんでした。

解説(Remarks)

GetVolumeProtectLevel メソッドは、ボリュームの現在の保護レベルに関する情報を取得します。ボリュームが障害状態にある場合、VSS_VOLUME_PROTECTION_INFO 構造体の m_protectionFault メンバーには現在の保護障害が格納され、m_failureStatus メンバーにはボリュームが障害状態にある理由が格納されます。ボリュームが障害状態にない場合、m_protectionFault メンバーと m_failureStatus メンバーは 0 になります。

vtbl 15 HRESULT ClearVolumeProtectFault(WORD* pwszVolumeName)

指定されたボリュームの保護障害状態を解除します。

pwszVolumeName

WORD*

ボリュームの名前。このパラメーターは必須であり、NULL を指定することはできません。

名前は次のいずれかの形式で指定し、末尾に円記号 (\) を含める必要があります。

マウントされたフォルダーのパス。例: Y:\MountX\
ドライブ文字。例: D:\
\\?\Volume{GUID}\ 形式のボリューム GUID パス (GUID はボリュームを識別します)

戻り値

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

値	意味
S_OK	保護障害状態が正常に解除されました。
E_ACCESSDENIED 0x80070005L	呼び出し元が管理者ではありません。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効です。
E_NOTIMPL 0x80000001L	このボリュームのプロバイダーはシャドウコピー保護をサポートしていません。
VSS_E_PROVIDER_VETO 0x80042306L	想定内のプロバイダーエラーが発生しました。エラーコードはイベントログに記録されます。詳細については、Event and Error Handling Under VSS を参照してください。
VSS_E_OBJECT_NOT_FOUND 0x80042308L	指定されたボリュームが見つかりませんでした。

解説(Remarks)

ClearVolumeProtectFault メソッドはボリュームをディスマウントし、ボリュームの保護障害メンバーを FALSE にリセットして、そのボリュームで通常の I/O を継続できるようにします。ボリュームが障害状態にない場合、このメソッドは何も行いません。

vtbl 16 HRESULT DeleteUnusedDiffAreas(WORD* pwszDiffAreaVolumeName)

指定されたボリューム上にある、使用されていないすべてのシャドウコピー記憶域 (差分領域とも呼ばれます) を削除します。

pwszDiffAreaVolumeName

WORD*

ボリュームの名前。このパラメーターは必須であり、NULL を指定することはできません。

名前は次のいずれかの形式で指定し、末尾に円記号 (\) を含める必要があります。

マウントされたフォルダーのパス。例: Y:\MountX\
ドライブ文字。例: D:\
\\?\Volume{GUID}\ 形式のボリューム GUID パス (GUID はボリュームを識別します)

戻り値

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

値	意味
S_OK	シャドウコピー記憶域が正常に削除されました。
E_ACCESSDENIED 0x80070005L	呼び出し元が管理者ではありません。
E_INVALIDARG 0x80070057L	いずれかのパラメーター値が無効です。
E_NOTIMPL 0x80000001L	このボリュームのプロバイダーはシャドウコピー保護をサポートしていません。
VSS_E_PROVIDER_VETO 0x80042306L	想定内のプロバイダーエラーが発生しました。エラーコードはイベントログに記録されます。詳細については、Event and Error Handling Under VSS を参照してください。
VSS_E_OBJECT_NOT_FOUND 0x80042308L	指定されたボリュームが見つかりませんでした。

解説(Remarks)

未使用のシャドウコピー記憶域ファイルは、関連付けられた元のボリュームが保護障害によりオフラインになっている場合に、記憶域ボリューム上に残ります。場合によっては元のボリュームが恒久的に失われることがあり、その際に放置された記憶域の領域を回収する唯一の手段が DeleteUnusedDiffAreas メソッドの呼び出しです。

vtbl 17 HRESULT QuerySnapshotDeltaBitmap(GUID idSnapshotOlder, GUID idSnapshotYounger, DWORD* pcBlockSizePerBit, DWORD* pcBitmapLength, BYTE** ppbBitmap)

このメソッドは将来の使用のために予約されています。(IVssDifferentialSoftwareSnapshotMgmt3.QuerySnapshotDeltaBitmap)

idSnapshotOlder	GUID	in	比較の基準となる古い方のスナップショットの識別子(GUID)を指定する。
idSnapshotYounger	GUID	in	比較対象となる新しい方のスナップショットの識別子(GUID)を指定する。
pcBlockSizePerBit	DWORD*	out	ビットマップの 1 ビットが表すブロックサイズをバイト単位で受け取るポインタである。
pcBitmapLength	DWORD*	out	返されるビットマップのバイト数を受け取るポインタである。
ppbBitmap	BYTE**	out	2 つのスナップショット間で変更されたブロックを示すビットマップデータを受け取るポインタへのポインタである。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

HSP用 COM定義

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

出力引数:

#define global IID_IVssDifferentialSoftwareSnapshotMgmt3 "{383F7E71-A4C5-401F-B27F-F826289F8458}"
#usecom global IVssDifferentialSoftwareSnapshotMgmt3 IID_IVssDifferentialSoftwareSnapshotMgmt3 "{}"
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_SetVolumeProtectLevel     13 var,int
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_GetVolumeProtectLevel     14 var,var
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_ClearVolumeProtectFault   15 var
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_DeleteUnusedDiffAreas     16 var
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_QuerySnapshotDeltaBitmap  17 int,int,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IVssDifferentialSoftwareSnapshotMgmt3 "{383F7E71-A4C5-401F-B27F-F826289F8458}"
#usecom global IVssDifferentialSoftwareSnapshotMgmt3 IID_IVssDifferentialSoftwareSnapshotMgmt3 "{}"
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_SetVolumeProtectLevel     13 sptr,int
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_GetVolumeProtectLevel     14 sptr,sptr
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_ClearVolumeProtectFault   15 sptr
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_DeleteUnusedDiffAreas     16 sptr
#comfunc global IVssDifferentialSoftwareSnapshotMgmt3_QuerySnapshotDeltaBitmap  17 int,int,sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。