IVssSoftwareSnapshotProvider::GetSnapshotProperties method (vsprov.h)
Gets the properties of the specified shadow copy.
Syntax
HRESULT GetSnapshotProperties(
[in] VSS_ID SnapshotId,
[out] VSS_SNAPSHOT_PROP *pProp
);
Parameters
[in] SnapshotId
Shadow copy identifier.
[out] pProp
The address of a caller-allocated VSS_SNAPSHOT_PROP structure that receives the shadow copy properties. The provider is responsible for setting the members of this structure. All members are required except m_pwszExposedName and m_pwszExposedPath, which the provider can set to NULL. The provider allocates memory for all string members that it sets in the structure. When the structure is no longer needed, the caller 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 |
---|---|
|
The requested information was successfully returned. |
|
The caller does not have sufficient backup privileges or is not an administrator. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
The specified volume was not found. |
|
Provider error. The provider logged the error in the event log. For more information, see Event and Error Handling Under VSS. |
|
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
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 Vista [desktop apps only] |
Minimum supported server | Windows Server 2003 [desktop apps only] |
Target Platform | Windows |
Header | vsprov.h |
Library | VssApi.lib |