IInkOverlay::Ink

4/8/2010

Gets or sets the IInkDisp object that is associated with an IInkOverlay object.

Syntax

[propputref] HRESULT putref_Ink ([in] InkDisp *Ink);
[propget] HRESULT get_Ink ([out, retval] InkDisp **Ink
);

Parameters

  • Ink
    Gets or sets the IInkDisp object that is associated with the IInkOverlay object.

    This property is read/write.

Return Value

HRESULT value Description

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

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

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