IVssComponent：：GetBackupMetadata 方法 (vswriter.h)

GetBackupMetadata 方法检索可能在 PrepareForBackup 事件期间由 CVssWriter：：OnPrepareBackup 使用 IVssComponent：：SetBackupMetadata 设置的特定于编写器的专用备份元数据。

只有编写器才能调用此方法。

语法

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

[out] pbstrData

调用方分配的变量的地址，该变量接收包含 OnPrepareBackup 事件期间添加的备份元数据的字符串。

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

值	含义
S_OK	已成功返回属性值。
S_FALSE	没有与此组件关联的备份元数据。
E_INVALIDARG	其中一个参数值无效。
E_OUTOFMEMORY	调用方内存不足或其他系统资源。
VSS_E_INVALID_XML_DOCUMENT	XML 文档无效。有关详细信息，请查看事件日志。有关详细信息，请参阅 VSS 下的事件和错误处理。

可以根据给定编写器的逻辑随时调用此方法。

如果未设置备份元数据， GetBackupMetadata 将返回S_FALSE。

如果对 GetBackupMetadata 的调用成功，则调用方负责通过调用 SysFreeString 函数释放 pbstrMetadata 参数中返回的字符串。