Edit

Share via

IVssBackupComponents::BreakSnapshotSet method (vsbackup.h)

  • Article

The BreakSnapshotSet method causes the existence of a shadow copy set to be "forgotten" by VSS.

Syntax

HRESULT BreakSnapshotSet(
  [in] VSS_ID SnapshotSetId
);

Parameters

[in] SnapshotSetId

Shadow copy set identifier.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 The shadow copy set was successfully broken.
E_ACCESSDENIED
 The caller does not have sufficient backup privileges or is not an administrator.
E_INVALIDARG
 One of the parameter values is not valid.
E_OUTOFMEMORY
 The caller is out of memory or other system resources.
VSS_E_OBJECT_NOT_FOUND
 The specified shadow copy does not exist.
VSS_E_PROVIDER_VETO
 The shadow copy was created by a software provider and cannot be broken.
VSS_E_UNEXPECTED
 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.

Remarks

BreakSnapshotSet can be used only for shadow copies created by a hardware shadow copy provider. This method makes these shadow copies regular volumes.

Shadow copies of volumes "broken" with BreakSnapshotSet must be managed independently of VSS as stand-alone volumes. See Breaking Shadow Copies for more information.

IVssBackupComponentsEx2::BreakSnapshotSetEx is similar to the BreakSnapshotSet method, except that it has extra parameters to query status and specify how the shadow copy set is broken.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h)
Library VssApi.lib

See also

IVssBackupComponents

IVssBackupComponents::DeleteSnapshots