Edit

Share via

IVssSoftwareSnapshotProvider::BeginPrepareSnapshot method (vsprov.h)

  • Article

VSS calls this method for each shadow copy that is added to the shadow copy set.

Syntax

HRESULT BeginPrepareSnapshot(
  [in] VSS_ID   SnapshotSetId,
  [in] VSS_ID   SnapshotId,
  [in] VSS_PWSZ pwszVolumeName,
  [in] LONG     lNewContext
);

Parameters

[in] SnapshotSetId

Shadow copy set identifier.

[in] SnapshotId

Identifier of the shadow copy to be created.

[in] pwszVolumeName

Null-terminated wide character string containing the volume name. The name must be in one of the following formats and must include a trailing backslash (\):

  • The path of a mounted folder, for example, Y:\MountX\
  • A drive letter, for example, D:\
  • A volume GUID path of the form \\?\Volume{GUID}\ (where GUID identifies the volume)

[in] lNewContext

The context for the shadow copy set. This context consists of a bitmask of _VSS_VOLUME_SNAPSHOT_ATTRIBUTES values.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 The shadow copy was successfully created.
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 volume was not found.
VSS_E_PROVIDER_VETO
 Provider error. The provider logged the error in the event log. For more information, see Event and Error Handling Under VSS.
VSS_E_UNSUPPORTED_CONTEXT
 The specified context is not supported.
VSS_E_VOLUME_NOT_SUPPORTED_BY_PROVIDER
 The provider does not support the specified volume.
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.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vsprov.h
Library VssApi.lib

See also

IVssSoftwareSnapshotProvider