IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotFile 方法 (vsbackup.h)

获取有关已从给定卷影副本中显式排除 的文件集 的信息。

语法

HRESULT GetExcludeFromSnapshotFile(
  [in]  UINT           iFile,
  [out] IVssWMFiledesc **ppFiledesc
);

参数

[in] iFile

排除 的文件集的索引。 此参数的值是一个介于 0 到 n–1(含)的整数之间,其中 n 是显式排除在给定卷影副本 中的文件集 总数。 n 的值由 IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotCount 方法返回。

[out] ppFiledesc

指向包含文件元素信息的 IVssWMFiledesc 对象的双间接指针。

返回值

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

含义
S_OK
已成功返回 指向 IVssWMFiledesc 接口的指针。
E_INVALIDARG
其中一个参数值无效。
E_OUTOFMEMORY
调用方内存不足或其他系统资源。
VSS_E_UNEXPECTED
意外错误。 错误代码记录在错误日志文件中。 有关详细信息,请参阅 VSS 下的事件和错误处理

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

注解

调用方负责调用 IUnknown::Release 方法来释放返回的 IVssWMFiledesc 对象的资源。

GetExcludeFromSnapshotFile 方法旨在报告有关从卷影副本中排除的文件集的信息。 请求者不应根据此方法返回的信息从备份中排除文件。

要求

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

另请参阅

IVssCreateWriterMetadataEx::AddExcludeFilesFromSnapshot

IVssExamineWriterMetadataEx2

IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotCount