This topic has not yet been rated - Rate this topic

EndDoc function

Applies to: desktop apps only

The EndDoc function ends a print job.

Syntax

int EndDoc(
  __in  HDC hdc
);

Parameters

hdc [in]

Handle to the device context for the print job.

Return value

If the function succeeds, the return value is greater than zero.

If the function fails, the return value is less than or equal to 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.

Applications should call EndDoc immediately after finishing a print job.

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

Minimum supported server

Windows 2000 Server

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Printing
Print Spooler API Functions
StartDoc

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
C# syntax
[DllImport("gdi32.dll")]
public static extern int EndDoc(IntPtr hdc);
vb.net syntax
<DllImport("gdi32.dll")> Public Shared Function EndDoc(ByVal hdc As IntPtr) As Integer
End Function