The StartDoc function starts a print job.

Syntax

int StartDoc(
  __in  HDC hdc,
  __in  const DOCINFO *lpdi
);

Parameters

hdc [in]

A handle to the device context for the print job.

lpdi [in]

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

Return Value

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.

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.

Examples

For an example, see Printing a Document.

Requirements

See Also

Printing and Print Spooler Overview

Printing and Print Spooler Functions

DOCINFO

EndDoc

GetJob

SetJob

Send comments about this topic to Microsoft

Build date: 11/16/2009