IVssBackupComponents::GetSnapshotProperties method (vsbackup.h)

Article
10/13/2021

The GetSnapshotProperties method gets the properties of the specified shadow copy.

Syntax

HRESULT GetSnapshotProperties(
  [in]  VSS_ID            SnapshotId,
  [out] VSS_SNAPSHOT_PROP *pProp
);

Parameters

[in] SnapshotId

The identifier of the shadow copy of a volume as returned by IVssBackupComponents::AddToSnapshotSet.

[out] pProp

The address of a caller-allocated VSS_SNAPSHOT_PROP structure that receives the shadow copy properties. The software provider is responsible for setting the members of this structure. The software provider allocates memory for all string members that it sets in the structure. When the structure is no longer needed, the software provider is responsible for freeing these strings by calling the VssFreeSnapshotProperties function.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned the shadow copy properties.
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_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_OBJECT_NOT_FOUND	The specified shadow copy does not exist.
VSS_E_PROVIDER_VETO	Expected 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.
VSS_E_UNEXPECTED_PROVIDER_ERROR	Unexpected provider error. The error code is logged in the error log. For more information, see Event and Error Handling Under VSS.

Remarks

The caller should set the contents of the VSS_SNAPSHOT_PROP structure to zero before calling the GetSnapshotProperties method.

The provider is responsible for allocating and freeing the strings in the VSS_SNAPSHOT_PROP structure.

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