IVssFileShareSnapshotProvider::GetSnapshotProperties method (vsprov.h)

  • Article

Gets the VSS_SNAPSHOT_PROP structure for a file share snapshot.

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
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.

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.

The VSS coordinator calls this method during the PostSnapshot phase of snapshot creation in order to retrieve the snapshot access path (UNC path for file share snapshots). The coordinator calls this method after PreFinalCommitSnapshots and before it invokes PostSnapshot in the writers.

Requirements

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

See also

IVssFileShareSnapshotProvider