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

IVssComponent::SetPreRestoreFailureMsg が設定されている場合、GetPreRestoreFailureMsg メソッドは、PreRestore イベントの処理中にライターによって生成されたエラー メッセージを取得します。

ライターまたはリクエスターは、このメソッドを呼び出すことができます。

構文

HRESULT GetPreRestoreFailureMsg(
  [out] BSTR *pbstrPreRestoreFailureMsg
);

パラメーター

[out] pbstrPreRestoreFailureMsg

PreRestore イベントの処理中に発生したエラーを説明するエラー メッセージを含む文字列。

戻り値

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

説明
S_OK
属性値が正常に返されました。
S_FALSE
PreRestore エラー メッセージを取得できません。
E_INVALIDARG
パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

解説

呼び出し元は、SysFreeString を呼び出して、pbstrPreRestoreFailureMsg パラメーターによって保持されているメモリを解放する必要があります。

SetPreRestoreFailureMsg を使用して PreRestore エラー メッセージを設定しなかった場合、GetPreRestoreFailureMsg はS_FALSEを返します。

要件

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

関連項目

IVssComponent

IVssComponent::GetPostRestoreFailureMsg

IVssComponent::SetPostRestoreFailureMsg

IVssComponent::SetPreRestoreFailureMsg