The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IPdfRendererNative::RenderPageToDeviceContext method

Outputs a single page of a Portable Document Format (PDF) file as a bitmap image.

Syntax

C++


HRESULT RenderPageToDeviceContext(
  [in]           IUnknown           *pdfPage,
  [in]           ID2D1DeviceContext *pD2DDeviceContext,
  [in, optional] PDF_RENDER_PARAMS  *pRenderParams
);

Parameters

pdfPage [in]

The IPdfPage interface as an instance of the PdfPage class, type-casted to the IUnknown interface, representing the page to be output.

pD2DDeviceContext [in]

A set of state and command buffers for outputting the page as a bitmap image.

pRenderParams [in, optional]

A set of page output properties, such as rendering only a portion of the page, rendering a scaled version of the page, setting the page's background color, and whether the page is shown in high contrast mode.

Provide a null pointer for this parameter to specify default page output properties. For the list of defaults, see PDF_RENDER_PARAMS.

Return value

This method can return one of these values.

Return code	Description
S_OK	The page output operation succeeded.

Error codes

For a list of possible error codes that this method can return, see d2derr.h.

Requirements

Minimum supported client	Windows 8.1 [Windows Store apps only]
Minimum supported server	Windows Server 2012 R2 [Windows Store apps only]
Header	Windows.data.pdf.interop.h
IDL	Windows.data.pdf.interop.idl
Library	Windows.data.pdf.lib
DLL	Windows.Data.Pdf.dll