IVssComponent::GetBackupMetadata メソッド (vswriter.h)

GetBackupMetadata メソッドは、IVssComponent::SetBackupMetadata を使用して、CVssWriter::OnPrepareBackup による PrepareForBackup イベント中に設定された可能性がある、ライター固有のプライベートバックアップメタデータを取得します。

ライターのみがこのメソッドを呼び出すことができます。

構文

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

[out] pbstrData

OnPrepareBackup イベント中に追加されたバックアップメタデータを含む文字列を受け取る呼び出し元割り当て変数のアドレス。

このメソッドの有効なリターンコードを次に示します。

値	意味
S_OK	属性値が正常に返されました。
S_FALSE	このコンポーネントに関連付けられているバックアップメタデータはありません。
E_INVALIDARG	パラメーター値の 1 つが無効です。
E_OUTOFMEMORY	呼び出し元がメモリやその他のシステムリソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細については、イベントログを確認してください。詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

このメソッドは、特定のライターのロジックに応じて、いつでも呼び出すことができます。

バックアップメタデータが設定されていない場合、 GetBackupMetadata はS_FALSEを返します。

GetBackupMetadata の呼び出しが成功した場合、呼び出し元は SysFreeString 関数を呼び出すことによって pbstrMetadata パラメーターで返される文字列を解放します。

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	vswriter.h (Vss.h、VsWriter.h を含む)
Library	VssApi.lib