IVssBackupComponents::StartSnapshotSet method (vsbackup.h)

The StartSnapshotSet method creates a new, empty shadow copy set.

Syntax

HRESULT StartSnapshotSet(
  [out] VSS_ID *pSnapshotSetId
);

Parameters

[out] pSnapshotSetId

The address of a caller-allocated variable that receives the shadow copy set identifier.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
Successfully started the shadow copy set.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.
VSS_E_BAD_STATE
The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.
VSS_E_SNAPSHOT_SET_IN_PROGRESS
The creation of a shadow copy is in progress, and only one shadow copy creation operation can be in progress at one time. Either wait to try again or return with a failure error code.
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

This method must be called before IVssBackupComponents::PrepareForBackup during backup operations.

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::PrepareForBackup