startDocA 函数 (wingdi.h)

StartDoc 函数启动打印作业。

语法

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

参数

[in] hdc

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

[in] lpdi

指向包含文档文件名和输出文件名称的 DOCINFO 结构的指针。

返回值

如果函数成功,则返回值大于 0。 此值是文档的打印作业标识符。

如果函数失败,则返回值小于或等于 0。

注解

注意 这是一个阻塞或同步函数,可能不会立即返回。 此函数返回的速度取决于运行时因素(例如网络状态、打印服务器配置和打印机驱动程序实现),这些因素在编写应用程序时难以预测。 从管理与用户界面交互的线程调用此函数可能会使应用程序看起来无响应。
 
应用程序应在开始打印作业之前立即调用 StartDoc 函数。 使用此函数可确保多页文档不会与其他打印作业穿插在一起。

应用程序可以使用 StartDoc 返回的值来检索或设置打印作业的优先级。 调用 GetJobSetJob 函数,并将此值作为所需参数之一提供。

示例

有关使用此函数的示例程序,请参阅 如何:使用 GDI 打印 API 进行打印

注意

wingdi.h 标头将 StartDoc 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定

要求

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

另请参阅

DOCINFO

EndDoc

GetJob

打印后台处理程序 API 函数

打印

SetJob