Export (0) Print
Expand All

IInkCursor::Inverted property

Applies to: desktop apps only

Gets a value that indicates whether the cursor is the inverted end of the pen.

This property is read-only.

Syntax

HRESULT get_Inverted(
  [out, retval]  VARIANT_BOOL *Inverted
);

Property value

VARIANT_TRUE if the cursor is the inverted end of the pen; otherwise, VARIANT_FALSE.

Error codes

NameMeaning
S_OK

Cursor is the inverted end of the pen.

E_INK_EXCEPTION

An exception occurred while processing.

E_POINTER

The context is invalid or the parameter is an invalid pointer.

Remarks

Inverted cursors are generally associated with erasing. A pen might have one end that is intended for drawing and another intended for erasing. For more information about erasing ink, see Erasing Ink with the Pen.

Whether or not you use the Inverted property is entirely up to the needs of your application. Applications are not required to inspect inverted cursors, and the ink collector applies default drawing attributes to inverted cursors just as it does to cursors that are not inverted.

Note  Accessing this property within certain message handlers can result in the underlying function being re-entered, causing unexpected results. Take care to avoid a reentrant call when handling any of 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). This is an issue with single-threaded apartment model applications.

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkCursor Interface
InkDrawingAttributes Class

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft