IInkCollector::SetSingleTabletIntegratedMode method (msinkaut.h)

Article
02/22/2024

Allows the ink collector (InkCollector, InkOverlay, or InkPicture) to collect ink from only one tablet. Ink from other tablets is ignored by the ink collector.

Syntax

HRESULT SetSingleTabletIntegratedMode(
  [in] IInkTablet *Tablet
);

Parameters

[in] Tablet

The tablet on which ink is collected, or drawn.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contained an invalid pointer.
E_INK_COLLECTOR_ENABLED	The tablet cannot change modes while the collector is enabled.
E_INK_EXCEPTION	An exception occurred while processing.
E_INK_INCOMPATIBLE_OBJECT	The tablet does not point to a compatible Ink object.

Remarks

To allow the ink collector to collect ink from all tablets, call the SetAllTabletsMode method.

Note The ink collector object or control that collects ink must be disabled before calling this method. To disable the InkCollector object or the InkOverlay object, set the Enabled property to FALSE. To disable the InkPicture control, set the InkEnabled property to FALSE. After calling the SetSingleTabletIntegratedMode method, re-enable the object or control by setting the Enabled (or InkEnabled) property to TRUE.

When this method is called, the Cursors property of the ink collector is set to the empty collection.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll