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

ライターが特定のコンポーネントに対して設定した PostSnapshot エラー メッセージ文字列を返します。

ライターと要求者の両方がこのメソッドを呼び出すことができます。 ライターは、 IVssBackupComponents::D OSnapshotSet 非同期操作が完了した後に、このメソッドを呼び出す必要があります。

構文

HRESULT GetPostSnapshotFailureMsg(
  [out] BSTR *pbstrFailureMsg
);

パラメーター

[out] pbstrFailureMsg

PostSnapshot イベントの処理中に発生したエラーを説明するエラー メッセージを含む、null で終わるワイド文字列へのポインター。

戻り値

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

説明
S_OK
エラー メッセージが正常に取得されました。
S_FALSE
コンポーネント に対して PostSnapshot エラー メッセージが設定されませんでした。
E_INVALIDARG
パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
呼び出し元がメモリやその他のシステム リソースを使い切れている。

解説

呼び出し元は、sysFreeString 関数を呼び出すことによって、pbstrFailureMsg パラメーターが指す文字列を解放します。

要件

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

関連項目

CVssWriter::OnPostSnapshot

IVssComponentEx

IVssComponentEx::SetPostSnapshotFailureMsg