Export (0) Print
Expand All
Expand Minimize

InkOverlay.CollectingInk property

Applies to: desktop apps only

Gets a value that specifies whether ink is currently being drawn on an ink collector (InkCollector, InkOverlay, or InkPicture).

This property is read-only.

Syntax

HRESULT get_CollectingInk(
  [out, retval]  VARIANT_BOOL *Collecting
);

Property value

VARIANT_TRUE if ink is being drawn on an ink collector; otherwise, VARIANT_FALSE.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The CollectingInk parameter is an invalid pointer.

E_INK_EXCEPTION

An exception occurred inside the method.

Remarks

You can use the CollectingInk property to see if ink is being drawn on an ink collector rather than monitoring the Stroke event.

Note  Because ink collection is happening on a different thread than your application code, it is possible that the CollectingInk property can change soon after you have checked it. Thus, your code may be operating under the assumption that the ink collector is not collecting ink, when in fact it is. If this occurs, an error is thrown. To be safe, put such code in a try-catch block.

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

InkOverlay Class

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft