IInkOverlay::Renderer

4/8/2010

Gets or sets the IInkRenderer object that is used to draw ink in the IInkOverlay object.

Syntax

[propputref] HRESULT putref_Renderer ([in] IInkRenderer *Renderer);
[propget] HRESULT get_Renderer ([out, retval] IInkRenderer 
    **Renderer
);

Parameters

  • Renderer
    The IInkRenderer object that is used to draw ink.

    This property is read/write.

Return Value

HRESULT value Description

S_OK

Success.

E_POINTER

The Renderer parameter is not a valid pointer.

E_INK_EXCEPTION

An exception occurred while processing.

Remarks

When handling certain window messages, changing the IInkRenderer associated with the IInkOverlay can cause a reentrant function call, generating unexpected results. For example, changing to a different IInkRenderer or modifying its transforms within a message handler can result in a reentrant call. This affects the following messages: WM_ACTIVATE, 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

Header msinkaut.h
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later

See Also

Concepts

Windows Mobile Ink Reference