Share via

IInkOverlay::SetEventInterest

  • Article

4/8/2010

Sets a value that indicates whether the IInkOverlay control has interest in a specified event.

Syntax

HRESULT SetEventInterest (
  [in] InkCollectorEventInterest eventId,
  [in] VARIANT_BOOL listen
);

Parameters

  • eventId
    The event to be listened for. Possible values for eventID appear in the InkCollectorEventInterest enumeration type.
  • Listen
    Specifies whether the event is being listened for. The value is TRUE if the event is being used and FALSE if it is being ignored.

Return Value

HRESULT value Description

S_OK

Success.

E_POINTER

A parameter contained an invalid pointer.

E_INVALIDARG

Invalid event interest.

E_INK_EXCEPTION

An exception occurred during processing.

Remarks

All IInkOverlay events can be toggled by using this method. Most of these events are turned off by default for performance reasons. The only event that is on by default is IInkOverlay::Stroke.

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