PrintWindow function (winuser.h)

The PrintWindow function copies a visual window into the specified device context (DC), typically a printer DC.

Syntax

BOOL PrintWindow(
  HWND hwnd,
  HDC  hdcBlt,
  UINT nFlags
);

Parameters

hwnd

A handle to the window that will be copied.

hdcBlt

A handle to the device context.

nFlags

The drawing options. It can be one of the following values.

Value	Meaning
PW_CLIENTONLY	Only the client area of the window is copied to hdcBlt. By default, the entire window is copied.

Return value

If the function succeeds, it returns a nonzero value.

If the function fails, it returns 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 application that owns the window referenced by hWnd processes the PrintWindow call and renders the image in the device context that is referenced by hdcBlt. The application receives a WM_PRINT message or, if the PW_PRINTCLIENT flag is specified, a WM_PRINTCLIENT message. For more information, see WM_PRINT and WM_PRINTCLIENT.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	winuser.h (include Windows.h)
Library	User32.lib
DLL	User32.dll
API set	ext-ms-win-ntuser-draw-l1-1-2 (introduced in Windows 10, version 10.0.10240)

See also

Painting and Drawing Messages

Painting and Drawing Overview

WM_PRINT

WM_PRINTCLIENT