IVssSoftwareSnapshotProvider::D eleteSnapshots メソッド (vsprov.h)
1 つ以上のシャドウ コピーまたはシャドウ コピー セットを削除します。
構文
HRESULT DeleteSnapshots(
[in] VSS_ID SourceObjectId,
[in] VSS_OBJECT_TYPE eSourceObjectType,
[in] BOOL bForceDelete,
[out] LONG *plDeletedSnapshots,
[out] VSS_ID *pNondeletedSnapshotID
);
パラメーター
[in] SourceObjectId
削除するシャドウ コピーまたはシャドウ コピー セットの識別子。
[in] eSourceObjectType
削除するオブジェクトの型。 このパラメーターの値は、VSS_OBJECT_SNAPSHOTまたはVSS_OBJECT_SNAPSHOT_SETです。
[in] bForceDelete
このパラメーターの値が TRUE の場合、プロバイダーはシャドウ コピー セット内のシャドウ コピーまたはシャドウ コピーを削除するために可能なすべての処理を行います。 FALSE の場合、追加の作業は行われません。
[out] plDeletedSnapshots
削除されたシャドウ コピーの数を受け取る変数へのポインター。
[out] pNondeletedSnapshotID
エラーが発生した場合、このパラメーターは、削除できなかった最初のシャドウ コピーの識別子へのポインターを受け取ります。 それ以外の場合は、GUID_NULLを指します。
戻り値
このメソッドの有効なリターン コードを次に示します。
値 | 意味 |
---|---|
|
シャドウ コピーが正常に削除されました。 |
|
呼び出し元が十分なバックアップ特権を持っていないか、管理者ではありません。 |
|
パラメーター値の 1 つが無効です。 |
|
呼び出し元がメモリやその他のシステム リソースを使い切れている。 |
|
指定したシャドウ コピーが見つかりませんでした。 |
|
プロバイダー エラー。 プロバイダーがイベント ログにエラーを記録しました。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。 |
注釈
シャドウ コピー セット内の複数のシャドウ コピーが順番に削除されます。 これらの個々の削除の間にエラーが発生した場合、 DeleteSnapshots はすぐに返されます。残りのシャドウ コピーは削除されません。 削除されていないシャドウ コピーのVSS_IDは、 pNondeletedSnapshotID で返されます。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | vsprov.h |
Library | VssApi.lib |