abortDoc 函数 (wingdi.h)

AbortDoc 函数停止当前打印作业,并清除自上次调用 StartDoc 函数以来绘制的所有内容。

语法

int AbortDoc(
  [in] HDC hdc
);

参数

[in] hdc

打印作业的设备上下文的句柄。

返回值

如果函数成功,则返回值大于 0。

如果函数失败,则返回值SP_ERROR。

注解

注意 这是一个阻塞或同步函数,可能不会立即返回。 此函数返回的速度取决于运行时因素(例如网络状态、打印服务器配置和打印机驱动程序实现),这些因素在编写应用程序时难以预测。 从管理与用户界面交互的线程调用此函数可能会使应用程序看起来无响应。
 
应用程序应调用 AbortDoc 函数以在发生错误时停止打印作业,或者在用户取消该作业后停止打印作业。 若要结束成功的打印作业,应用程序应调用 EndDoc 函数。

如果使用打印管理器启动打印作业,则调用 AbortDoc 会擦除整个后台打印作业,使打印机不接收任何内容。 如果未使用打印管理器启动打印作业,则数据可能已发送到打印机。 在这种情况下,打印机驱动程序会尽可能重置打印机 () 并结束打印作业。

要求

要求
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 wingdi.h (包括 Windows.h)
Library Gdi32.lib
DLL Gdi32.dll

另请参阅

EndDoc

打印后台处理程序 API 函数

打印

SetAbortProc

StartDoc