Renderer For Windows

Definitions for a rendering engine on windows.
Definitions and functions in this module are included in fs_renderer_windows_r.h.
Module: Renderer
License Identifier: Renderer/All
Available License Right: Unnecessary. More...

Functions
FS_RESULT	FSCRT_Renderer_CreateOnWindowsDC (HDC hDC, FSCRT_RENDERER *renderer)
	Create a renderer on a Windows device context for printing. More...

Detailed Description

Definitions for a rendering engine on windows.
Definitions and functions in this module are included in fs_renderer_windows_r.h.
Module: Renderer
License Identifier: Renderer/All
Available License Right: Unnecessary.

This module contains the following features:

• 1. Renderer for windows:
  • a. Create a windows renderer object based upon a HDC object.
  • b. HDC is a standard graphics object in WIN32 system. This provides a convenient function to call windows applications.
  • c. Note: to set properties of a renderer object, please refer to functions defined in fs_renderer_r.h.

Function Documentation

FS_RESULT FSCRT_Renderer_CreateOnWindowsDC	(	HDC	hDC,
		FSCRT_RENDERER *	renderer
	)

Create a renderer on a Windows device context for printing.

Renderer is a term of graphics engine in Foxit PDF SDK, it provides basic management and drawing operations.
There are two approaches to use a renderer: one is to draw on a renderer directly, and the other one is to output document contents by using a graphics context.
PDF module provides a rendering context to output page contents. Please refer to function FSPDF_RenderContext_Create.

Parameters

[in]	hDC	Handle to a HDC object which is a windows device.
[out]	renderer	Pointer to a FSCRT_RENDERER handle that receives the new renderer object.

Returns

FSCRT_ERRCODE_SUCCESS for success.
FSCRT_ERRCODE_PARAM if the parameter hDC or renderer is NULL.
FSCRT_ERRCODE_UNRECOVERABLE if an unrecoverable error occurs.
FSCRT_ERRCODE_OUTOFMEMORY if there is not enough memory or invalid memory access.
FSCRT_ERRCODE_ERROR if fail to create renderer on the specified parameter hDC for other reasons.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.

Note

This function can only be used on windows desktop platform and does not support Windows Store App. This function should be used only for printing, and caller should always use function FSCRT_Renderer_CreateOnBitmap for viewing the PDF. Foxit PDF SDK will extend supports on more platform-based native devices.

Attention

Thread Safety: this function is thread safe.
OOM Information:
OOM handling is only for mobile platforms, not for server or desktop.

• This function is long-term recoverable.
• renderer: this handle is long-term recoverable.

Please refer to the document "Robust PDF Applications with Limited Memory" for more details.