Поделиться через


Метод 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, Windows XP с пакетом обновления 2 (SP2) [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header imapi2.h

См. также раздел

DWriteEngine2Events

IWriteEngine2

IWriteEngine2::WriteSection

IWriteEngine2::get_WriteInProgress