Edit

Share via

IVssSoftwareSnapshotProvider::IsVolumeSnapshotted method (vsprov.h)

  • Article

Determines whether any shadow copies exist for the specified volume.

Syntax

HRESULT IsVolumeSnapshotted(
  [in]  VSS_PWSZ pwszVolumeName,
  [out] BOOL     *pbSnapshotsPresent,
  [out] LONG     *plSnapshotCompatibility
);

Parameters

[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)

[out] pbSnapshotsPresent

This parameter receives TRUE if the volume has a shadow copy, or FALSE if the volume does not have a shadow copy.

[out] plSnapshotCompatibility

A bitmask of VSS_SNAPSHOT_COMPATIBILITY values that indicate whether certain volume control or file I/O operations are disabled for the given volume, if the volume has a shadow copy.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 The requested information was successfully returned.
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_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

If no volume control or file I/O operations are disabled for the selected volume, then the shadow copy capability of the selected volume returned by plSnapshotCapability will be zero.

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