Export (0) Print
Expand All
Expand Minimize

InkOverlay.Ink property

Applies to: desktop apps only

Gets or sets the InkDisp object that is associated with an InkCollector object or an InkOverlay object.

This property is read/write.

Syntax

HRESULT put_Ink(
  [in]           InkDisp *NewInk
);

HRESULT get_Ink(
  [out, retval]  InkDisp **Ink
);

Property value

The InkDisp object that is associated with an InkCollector object or an InkOverlay object.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The Ink parameter must be a valid pointer to an Ink pointer.

E_INK_COLLECTOR_ENABLED

Cannot change Ink object while collecting.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INVALIDARG

Invalid hWnd value.

Remarks

Note  The InkCollector object or the InkOverlay object must be disabled before setting this property. To disable the InkCollector object or the InkOverlay object, set the Enabled property to FALSE. You can then set the Ink property, and re-enable the object by setting the Enabled property to TRUE.

An InkCollector creates an InkDisp object by default. If two or more InkDisp objects exist on a known application window, they can be switched out to enable collection into any of them (such as after deserializing one of the InkDisp objects).

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
Enabled Property
InkDisp Class

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft