IInkTablets::Item method (msinkaut.h)

Retrieves the IInkTablet object at the specified index within the InkTablets collection.

Syntax

HRESULT Item(
  [in]          long       Index,
  [out, retval] IInkTablet **Tablet
);

Parameters

[in] Index

The zero-based index of the IInkTablet object to get.

[out, retval] Tablet

When this method returns, contains a pointer to the IInkTablet object at the specified index within the InkTablets collection.

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_FAIL	An unspecified error occurred.
CO_E_CLASSTRING	Invalid GUID format.
DISP_E_TYPEMISMATCH	One of the parameters is not a valid VARIANT type.
E_INVALIDARG	Invalid argument.
E_UNEXPECTED	Unexpected parameter or property type.
REGDB_CLASSNOTREG	Type object not registered.
E_OUTOFMEMORY	Cannot allocate memory to complete the operation.
E_INK_EXCEPTION	An exception occurred inside the method.
TPC_E_RECOGNIZER_NOT_REGISTERED	The recognizers registry key is corrupted or your environment does not support handwriting recognition.

Remarks

An error occurs if the index doesn't match any existing member of the collection.

Note  This function can be re-entered when called within certain message handlers, 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

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

See also

IInkTablet Interface

IInkTablets

InkTablets Collection