| UID | title | description | helpviewer_keywords | old-location | tech.root | ms.assetid | ms.date | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | req.redist | ms.custom | f1_keywords | dev_langs | topic_type | api_type | api_location | api_name | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:vsbackup.IVssBackupComponents.DeleteSnapshots |
IVssBackupComponents::DeleteSnapshots (vsbackup.h) |
The DeleteSnapshots method deletes one or more shadow copies or a shadow copy set. |
|
base\ivssbackupcomponents_deletesnapshots.htm |
base |
2e06f69e-8210-4773-8080-5c58e6f59792 |
12/05/2018 |
DeleteSnapshots, DeleteSnapshots method [VSS], DeleteSnapshots method [VSS],IVssBackupComponents interface, IVssBackupComponents interface [VSS],DeleteSnapshots method, IVssBackupComponents.DeleteSnapshots, IVssBackupComponents::DeleteSnapshots, _win32_ivssbackupcomponents_deletesnapshots, base.ivssbackupcomponents_deletesnapshots, vsbackup/IVssBackupComponents::DeleteSnapshots |
vsbackup.h |
VsBackup.h, Vss.h, VsWriter.h |
Windows |
Windows XP [desktop apps only] |
Windows Server 2003 [desktop apps only] |
VssApi.lib |
Windows |
19H1 |
|
|
|
|
|
|
The DeleteSnapshots method deletes one or more shadow copies or a shadow copy set.
Identifier of the shadow copy or a shadow copy set to be deleted.
Type of the object on which all shadow copies will be deleted. The value of this parameter is VSS_OBJECT_SNAPSHOT or VSS_OBJECT_SNAPSHOT_SET.
If the value of this parameter is TRUE, the provider will do everything possible to delete the shadow copy or shadow copies in a shadow copy set. If it is FALSE, no additional effort will be made.
Number of deleted shadow copies.
If an error occurs, the value of this parameter is the identifier of the first shadow copy that could not be deleted. Otherwise, it is GUID_NULL.
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
The shadow copies were successfully deleted. |
|
The caller does not have sufficient backup privileges or is not an administrator. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
Unexpected error. The error code is logged in the error log file. For more information, see
Event and Error Handling Under VSS.
Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead. |
|
The specified shadow copy does not exist. |
|
Expected provider error. The provider logged the error in the event log. For more information, see Event and Error Handling Under VSS. |
|
Unexpected provider error. The error code is logged in the error log. For more information, see Event and Error Handling Under VSS. |
Multiple shadow copies in a shadow copy set are deleted sequentially. If an error occurs during one of these individual deletions, DeleteSnapshots will return immediately; no attempt will be made to delete any remaining shadow copies. The VSS_ID of the undeleted shadow copy is returned in pNondeletedSnapshotID.
The requester is responsible for serializing the delete shadow copy operation.
During a backup, shadow copies are automatically released as soon as the IVssBackupComponents instance is released. In this case, it is not necessary to explicitly delete shadow copies.