Skip to content

Latest commit

 

History

History
170 lines (142 loc) · 5.09 KB

nf-vsprov-ivsssoftwaresnapshotprovider-getsnapshotproperties.md

File metadata and controls

170 lines (142 loc) · 5.09 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:vsprov.IVssSoftwareSnapshotProvider.GetSnapshotProperties
IVssSoftwareSnapshotProvider::GetSnapshotProperties (vsprov.h)
Gets the properties of the specified shadow copy.
GetSnapshotProperties
GetSnapshotProperties method
GetSnapshotProperties method
IVssSoftwareSnapshotProvider interface
IVssSoftwareSnapshotProvider interface
GetSnapshotProperties method
IVssSoftwareSnapshotProvider.GetSnapshotProperties
IVssSoftwareSnapshotProvider::GetSnapshotProperties
base.ivsssoftwaresnapshotprovider_getsnapshotproperties
vsprov/IVssSoftwareSnapshotProvider::GetSnapshotProperties
base\ivsssoftwaresnapshotprovider_getsnapshotproperties.htm
base
59886344-d594-4eb8-9718-ab11a6627e8e
12/05/2018
GetSnapshotProperties, GetSnapshotProperties method, GetSnapshotProperties method,IVssSoftwareSnapshotProvider interface, IVssSoftwareSnapshotProvider interface,GetSnapshotProperties method, IVssSoftwareSnapshotProvider.GetSnapshotProperties, IVssSoftwareSnapshotProvider::GetSnapshotProperties, base.ivsssoftwaresnapshotprovider_getsnapshotproperties, vsprov/IVssSoftwareSnapshotProvider::GetSnapshotProperties
vsprov.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
VssApi.lib
Windows
19H1
IVssSoftwareSnapshotProvider::GetSnapshotProperties
vsprov/IVssSoftwareSnapshotProvider::GetSnapshotProperties
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
IVssSoftwareSnapshotProvider.GetSnapshotProperties

IVssSoftwareSnapshotProvider::GetSnapshotProperties

-description

Gets the properties of the specified shadow copy.

-parameters

-param SnapshotId [in]

Shadow copy identifier.

-param pProp [out]

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.

-returns

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

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.

-see-also

IVssSoftwareSnapshotProvider

VssFreeSnapshotProperties