Edit

Share via

ID2D1Device::CreatePrintControl(IWICImagingFactory*,IPrintDocumentPackageTarget*,constD2D1_PRINT_CONTROL_PROPERTIES&,ID2D1PrintControl**) method (d2d1_1.h)

Creates an ID2D1PrintControl object that converts Direct2D primitives stored in ID2D1CommandList into a fixed page representation. The print sub-system then consumes the primitives.

Syntax

HRESULT CreatePrintControl(
  [in]                IWICImagingFactory                    *wicFactory,
  [in]                IPrintDocumentPackageTarget           *documentTarget,
  [in, ref, optional] const D2D1_PRINT_CONTROL_PROPERTIES & printControlProperties,
  [out]               ID2D1PrintControl                     **printControl
);

Parameters

[in] wicFactory

Type: IWICImagingFactory*

A WIC imaging factory.

[in] documentTarget

Type: IPrintDocumentPackageTarget*

The target print job for this control.

[in, ref, optional] printControlProperties

Type: const D2D1_PRINT_CONTROL_PROPERTIES

The options to be applied to the print control.

[out] printControl

Type: ID2D1PrintControl**

When this method returns, contains the address of a pointer to an ID2D1PrintControl object.

Return value

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

HRESULT Description
S_OK No error occurred.
E_OUTOFMEMORY Direct2D could not allocate sufficient memory to complete the call.
E_FAIL Generic failure code.
D2DERR_PRINT_FORMAT_NOT_SUPPORTED The print format is not supported by the document target.

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.
 

Requirements

Requirement Value
Minimum supported client Windows 8 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header d2d1_1.h
Library D2d1.lib
DLL D2d1.dll

See also

ID2D1Device