IVssBackupComponents::GetSnapshotProperties 方法 (vsbackup.h)

GetSnapshotProperties 方法获取指定卷影副本的属性。

语法

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

参数

[in] SnapshotId

由 IVssBackupComponents::AddToSnapshotSet 返回的卷的卷影副本的标识符。

[out] pProp

接收卷影复制属性的调用方分配 VSS_SNAPSHOT_PROP 结构的地址。 软件提供商负责设置此结构的成员。 软件提供程序为它在 结构中设置的所有字符串成员分配内存。 当不再需要结构时,软件提供程序负责通过调用 VssFreeSnapshotProperties 函数来释放这些字符串。

返回值

下面是此方法的有效返回代码。

含义
S_OK
已成功返回卷影复制属性。
E_ACCESSDENIED
调用方没有足够的备份权限或不是管理员。
E_INVALIDARG
其中一个参数值无效。
E_OUTOFMEMORY
调用方内存不足或其他系统资源。
VSS_E_BAD_STATE
备份组件对象未初始化,在还原操作期间调用了此方法,或者尚未在正确的顺序中调用此方法。
VSS_E_OBJECT_NOT_FOUND
指定的卷影副本不存在。
VSS_E_PROVIDER_VETO
预期的提供程序错误。 提供程序在事件日志中记录了错误。 有关详细信息,请参阅 VSS 下的事件和错误处理
VSS_E_UNEXPECTED
意外错误。 错误代码记录在错误日志文件中。 有关详细信息,请参阅 VSS 下的事件和错误处理

Windows Server 2008、Windows Vista、Windows Server 2003 和 Windows XP: 在 Windows Server 2008 R2 和 Windows 7 之前,不支持此值。 改用E_UNEXPECTED。

VSS_E_UNEXPECTED_PROVIDER_ERROR
意外的提供程序错误。 错误代码记录在错误日志中。 有关详细信息,请参阅 VSS 下的事件和错误处理

注解

调用方在调用 GetSnapshotProperties 方法之前,应将 VSS_SNAPSHOT_PROP 结构的内容设置为零。

提供程序负责分配和释放 VSS_SNAPSHOT_PROP 结构中的字符串。

要求

   
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 vsbackup.h (包括 VsBackup.h、Vss.h、VsWriter.h)
Library VssApi.lib

另请参阅

IVssBackupComponents

IVssBackupComponents::AddToSnapshotSet

IVssBackupComponents::StartSnapshotSet

VSS_ID

VSS_SNAPSHOT_PROP

VssFreeSnapshotProperties