大网数据广告活动
打印与设备

StartDocPrinter function (Winspool.h)

· 52CE 我爱测

The StartDocPrinter function notifies the print spooler that a document is to be spooled for printing.

The StartDocPrinter function notifies the print spooler that a document is to be spooled for printing.

Syntax

DWORD StartDocPrinter(
  _In_ HANDLE hPrinter,
  _In_ DWORD  Level,
  _In_ LPBYTE pDocInfo
);

Parameters

hPrinter [in]

A handle to the printer. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.

Level [in]

The version of the structure to which pDocInfo points. This value must be 1.

pDocInfo [in]

A pointer to a DOC_INFO_1 structure that describes the document to print.

Return value

If the function succeeds, the return value identifies the print job.

If the function fails, the return value is zero.

Remarks

Note:
This is a blocking or synchronous function and might not return immediately. How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

The typical sequence for a print job is as follows:

  1. To begin a print job, call StartDocPrinter.
  2. To begin each page, call StartPagePrinter.
  3. To write data to a page, call WritePrinter.
  4. To end each page, call EndPagePrinter.
  5. Repeat 2, 3, and 4 for as many pages as necessary.
  6. To end the print job, call EndDocPrinter.

Note that calling StartPagePrinter and EndPagePrinter may not be necessary, such as if the print data type includes the page information.

When a page in a spooled file exceeds approximately 350 MB, it can fail to print and not send an error message. For example, this can occur when printing large EMF files. The page size limit depends on many factors including the amount of virtual memory available, the amount of memory allocated by calling processes, and the amount of fragmentation in the process heap.

Examples

For a sample program that uses this function, see How To: Print Using the GDI Print API.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header Winspool.h (include Windows.h)
Library Winspool.lib
DLL Winspool.drv
Unicode and ANSI names StartDocPrinterW (Unicode) and StartDocPrinterA (ANSI)

See also

AddJob

DOC_INFO_1

DOC_INFO_2

EndDocPrinter

EndPagePrinter

OpenPrinter

Printing

Print Spooler API Functions

StartPagePrinter

WritePrinter

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 05/31/2018
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。