IVssBackupComponentsEx2::BreakSnapshotSetEx method (vsbackup.h)

Article
02/22/2024

Breaks a shadow copy set according to requester-specified options.

Syntax

HRESULT BreakSnapshotSetEx(
  [in]  VSS_ID    SnapshotSetID,
  [in]  DWORD     dwBreakFlags,
  [out] IVssAsync **ppAsync
);

Parameters

[in] SnapshotSetID

A shadow copy set identifier.

[in] dwBreakFlags

A bitmask of _VSS_HARDWARE_OPTIONS flags that specify how the shadow copy set is broken.

[out] ppAsync

A pointer to a variable that receives an IVssAsync interface pointer that can be used to retrieve the status of the shadow copy set break operation. When the break operation is complete, the IUnknown::Release method must be called for this interface pointer.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK 0x00000000L	The shadow copy set was successfully broken.
E_ACCESSDENIED 0x80070005L	The caller does not have sufficient privileges or is not an administrator.
E_INVALIDARG 0x80070057L	One of the parameter values is not valid.
E_OUTOFMEMORY 0x8007000EL	The caller is out of memory or other system resources.
VSS_E_BREAK_REVERT_ID_FAILED 0x800423F6L	The shadow copy set break operation failed because the MBR disk signature, the GPT disk identifier, or the GPT partition identifier of one or more of the destination LUNs could not be reverted to those of the original LUNs. If one or more original LUNs are not masked on the computer, the break operation would cause a signature collision.
VSS_E_OBJECT_NOT_FOUND 0x80042308L	The specified shadow copy does not exist.
VSS_E_PROVIDER_VETO 0x80042306L	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

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

Like BreakSnapshotSet, BreakSnapshotSetEx can be used only for shadow copies that were created by a hardware shadow copy provider.

After this method returns, the shadow copy volume is still a volume, but it is no longer a shadow copy. For more information, see Breaking Shadow Copies.

Requirements

Requirement	Value
Minimum supported client	Windows Vista with SP1 [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h)

Share via