IVssBackupComponents：：SetBackupOptions 方法 (vsbackup.h)

  • 项目

SetBackupOptions 方法为组件设置一个私有或依赖于编写器的备份参数的字符串。

语法

HRESULT SetBackupOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszBackupOptions
);

参数

[in] writerId

编写器标识符。

[in] ct

组件的类型。 有关可能的值 ，请参阅VSS_COMPONENT_TYPE 。

[in] wszLogicalPath

以 Null 结尾的宽字符串，包含组件的逻辑路径。

有关详细信息，请参阅组件的逻辑路径。

包含此处使用的逻辑路径的字符串的值应与使用 IVssBackupComponents：：AddComponent 将组件添加到备份集时使用的值相同。

逻辑路径可以为 NULL。

对可以出现在非 NULL 逻辑路径中的字符没有限制。

[in] wszComponentName

包含组件名称的以 Null 结尾的宽字符串。

包含名称的字符串不能为 NULL ，应包含与使用 IVssBackupComponents：：AddComponent 将组件添加到备份集时使用的组件名称相同。

[in] wszBackupOptions

以 Null 结尾的宽字符串，包含要设置的备份参数。

返回值

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

值 含义
S_OK
 已成功设置备份选项。
E_INVALIDARG
 其中一个参数值无效。
E_OUTOFMEMORY
 调用方内存不足或其他系统资源。
VSS_E_BAD_STATE
 备份组件对象未初始化，在还原操作期间调用了此方法，或者尚未在正确的顺序中调用此方法。
VSS_E_OBJECT_NOT_FOUND
 备份组件不存在。
VSS_E_INVALID_XML_DOCUMENT
 XML 文档无效。 有关详细信息，请查看事件日志。 有关详细信息，请参阅 VSS 下的事件和错误处理。
VSS_E_UNEXPECTED
 意外错误。 错误代码记录在错误日志文件中。 有关详细信息，请参阅 VSS 下的事件和错误处理。

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

注解

SetBackupOptions 方法的 wszBackupOptions 参数设置的备份选项的确切语法和内容将取决于所联系的特定编写器。

必须在 IVssBackupComponents：:P repareForBackup 之前调用此方法。

要求

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

另请参阅

IVssBackupComponents

IVssBackupComponents：:P repareForBackup

IVssBackupComponents：：SetRestoreOptions

VSS_COMPONENT_TYPE