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

関連項目

CSVsWriter::OnPrepareBackup

IVssComponentEx

IVssComponentEx::GetPrepareForBackupFailureMsg