InkCollector.Tablet property

Gets either the IInkTablet object to which a cursor belongs or the IInkTablet object that an object or control is currently using to collect input.

This property is read-only.

Syntax


HRESULT get_Tablet(
  [out, retval] IInkTablet **SingleTablet
);

Property value

Either the IInkTablet object to which a cursor belongs or the IInkTablet object that an object or control is currently using to collect input.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The Tablet parameter is not a valid pointer to an IInkTablet object.

E_OUTOFMEMORY

Cannot allocate memory to complete the operation.

E_FAIL

An unspecified error occurs.

E_INK_EXCEPTION

An exception occurs while processing.

Remarks

For an object or control that collects ink, this property is valid only when the object or control is collecting ink from just one tablet. Accessing this property for an object or control that is collecting ink from all tablets generates an exception.

Accessing this property within certain message handlers can result in the underlying function being re-entered, causing unexpected results. Take care to avoid a reentrant call when handling any of the following messages: WM_ACTIVATE, WM_ACTIVATEAPP, WM_NCACTIVATE, WM_PAINT; WM_SYSCOMMAND if wParam is set to SC_HOTKEY or SC_TASKLIST; and WM_SYSKEYDOWN (when processing Alt-Tab or Alt-Esc key combinations). This is an issue with single-threaded apartment model applications.

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

InkCollector Class
Id Property
SetAllTabletsMode Method
SetSingleTabletIntegratedMode Method
IInkTablet Interface

 

 

Show: