IVssComponentEx::SetPrepareForBackupFailureMsg メソッド (vswriter.h)

コンポーネントの PrepareForBackup エラーメッセージ文字列を設定します。

このメソッドは、ライターの CSVsWriter::OnPrepareBackup メソッドによってのみ呼び出すことができます。

構文

HRESULT SetPrepareForBackupFailureMsg(
  [in] LPCWSTR wszFailureMsg
);

[in] wszFailureMsg

PrepareForBackup イベントの処理中に発生したエラーを説明するエラーメッセージを含む、呼び出し元によって割り当てられた NULL で終わるワイド文字列のアドレス。

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

値	説明
S_OK	エラーメッセージが正常に設定されました。
E_INVALIDARG	パラメーター値の 1 つが無効です。
E_OUTOFMEMORY	呼び出し元がメモリ不足またはその他のシステムリソースです。
VSS_E_BAD_STATE	このメソッドは、ライターの CSVsWriter::OnPrepareBackup メソッドによって呼び出されませんでした。

SetPrepareForBackupFailureMsg によって設定されたエラーメッセージは、コンポーネント内のすべてのファイルとサブコンポーネントに適用されます。


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