IVssExamineWriterMetadata：：GetExcludeFile 方法 (vsbackup.h)

GetExcludeFile 方法获取有关已从给定编写器备份中显式排除的文件的信息。

语法

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

[in] iFile

排除的文件集的索引。此参数的值是一个介于 0 到 n–1（含 0 到 n–1）的整数，其中 n 是从给定编写器组件中显式排除的文件集的总数。 n 的值由 IVssExamineWriterMetadata：：GetFileCounts 返回。

[out] ppFiledesc

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

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

值	含义
S_OK	已成功返回指向 IVssWMFiledesc 接口的指针。
E_INVALIDARG	其中一个参数值无效。
E_OUTOFMEMORY	调用方内存或其他系统资源不足。
VSS_E_INVALID_XML_DOCUMENT	XML 文档无效。有关详细信息，请查看事件日志。有关详细信息，请参阅 VSS 下的事件和错误处理。
VSS_E_OBJECT_NOT_FOUND	为排除指定的文件集不存在。
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 对象的资源。


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