Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

StartPagePrinter function

The StartPagePrinter function notifies the spooler that a page is about to be printed on the specified printer.

Syntax


BOOL StartPagePrinter(
  _In_  HANDLE hPrinter
);

Parameters

hPrinter [in]

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

Return value

If the function succeeds, the return value is a nonzero value.

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 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.

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

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

Spoolss.dll

See also

Printing
Print Spooler API Functions
EndDocPrinter
EndPagePrinter
OpenPrinter
StartDocPrinter
StartPagePrinter
WritePrinter

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.