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 SP2 [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 imapi2.h

另请参阅

DWriteEngine2Events

IWriteEngine2

IWriteEngine2::WriteSection

IWriteEngine2::get_WriteInProgress