IWriteEngine2::CancelWrite メソッド (imapi2.h)

処理中の書き込み操作を取り消します。

構文

HRESULT CancelWrite();

成功すると次の値が返されますが、実装の結果として他の成功コードが返される場合があります。一般的に、次のエラーコードは操作の失敗時に返されますが、考えられる唯一のエラー値を表すわけではありません。

リターンコード	説明
S_OK	メソッドが成功しました。
S_IMAPI_WRITE_NOT_IN_PROGRESS	IWriteEngine2::WriteSection の最後の呼び出しによって開始された "書き込み" 操作はまだ開始されておらず、取り消すことはできません。別の成功コードが返されるまで、IWriteEngine2::CancelWrite を呼び出すことが推奨されます。値: 0x00AA0302L

次のエラーコードは、通常、操作の失敗時に返されますが、考えられる唯一のエラー値を表すわけではありません。

リターンコード	説明
E_FAIL	不特定のエラー。値: 0x80004005

書き込み操作を取り消すには、実装した DWriteEngine2Events::Update イベントハンドラーからこのメソッドを呼び出す必要があります。

要件	値
サポートされている最小のクライアント	Windows Vista、SP2 を使用した Windows XP [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	imapi2.h