Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Renderer Property

InkOverlay.Renderer property

Gets or sets the InkRenderer object that is used to draw ink.

This property is read/write.

Syntax


HRESULT put_Renderer(
  [in]          IInkRenderer *NewInkRenderer
);

HRESULT get_Renderer(
  [out, retval] IInkRenderer **CurrentInkRenderer
);

Property value

The InkRenderer object that is used to draw ink.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The Renderer parameter is not a valid pointer.

E_INK_EXCEPTION

An exception occurred while processing.

E_INK_INVALID_MODE

The ink collector must be in single-tablet mode.

Remarks

When handling certain window messages, changing the Renderer associated with the InkOverlay can cause a reentrant function call, generating unexpected results. For example, changing to a different Renderer or modifying its transforms within a message handler can result in a reentrant call. This affects the following messages: WM_ACTIVATE, WM_ACTIVATEAPP, WM_NCACTIVATE, WM_PAINT; WM_SYSCOMMAND if wParam is set to SC_HOTKEY or SC_TASKLIST; and WM_SYSKEYDOWN (when processing Alt-Tab or Alt-Esc key combinations). It is an issue with single-threaded apartment model applications.

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkOverlay Class

 

 

Community Additions

ADD
Show:
© 2015 Microsoft