StartDoc function
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 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 |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
StartDocW (Unicode) and StartDocA (ANSI) |
See also