StartDoc

The StartDoc function starts a print job. This function replaces the STARTDOC printer escape.

int StartDoc(
  HDC hdc,              // handle to device context
  CONST DOCINFO *lpdi   // address of structure with file names
);
 

Parameters

hdc

Handle to the device context for the print job.

lpdi

Pointer to a DOCINFO structure containing the name of the document file and the name of the output file.

Return Values

If the function succeeds, the return value is greater than zero. This value is the print job identifier for the document.

If the function fails, the return value is less than or equal to zero.

Windows NT: To get extended error information, call GetLastError.

Remarks

Applications should call the StartDoc function immediately before beginning a print job. Using this function ensures that multipage documents are not interspersed with other print jobs.

Applications can use the value returned by StartDoc to retrieve or set the priority of a print job. Call the GetJob or SetJob function and supply this value as one of the required arguments.

Windows CE: Windows CE does not support printing to files. It ignores the lpszOutput member of the DOCINFO structure.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 2.0 or later.
  Header: Declared in wingdi.h.
  Import Library: Use gdi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Printing and Print Spooler Overview, Printing and Print Spooler Functions, DOCINFO, EndDoc, GetJob, SetJob