InkOverlay.SetEventInterest method

Sets a value that indicates whether an object or control has interest in a specified event.

Syntax


HRESULT SetEventInterest(
  [in] InkCollectorEventInterest EventId,
  [in] VARIANT_BOOL              Listen
);

Parameters

EventId [in]

The event to be listened for. Possible values for EventID appear in the InkCollectorEventInterest enumeration type.

Listen [in]

VARIANT_TRUE if the event is being used and VARIANT_FALSE if it is being ignored.

Return value

This method can return one of these values.

Return codeDescription
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 ink collector events can be toggled by using this method. Most of these events are turned off by default for performance reasons. The only events that are on by default are Stroke, CursorInRange, and CursorOutOfRange.

Use the NewPackets, NewInAirPackets and CursorDown events carefully, in particular because they may have an adverse effect on ink performance if too much code is executed in the event handlers.

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkOverlay Class
CursorDown Event
CursorInRange Event
GetEventInterest Method
InkCollectorEventInterest Enumeration
NewPackets Event
Stroke Event

 

 

Show: