IInkPicture::get_CollectingInk method (msinkaut.h)

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

This property is read-only.


HRESULT get_CollectingInk(
  VARIANT_BOOL *Collecting



Return value



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.


Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header msinkaut.h
Library InkObj.dll

See also


InkPicture Control