IInkCustomStrokes::Item method (msinkaut.h)

Retrieves the InkStrokes Collection at the location specified within the IInkCustomStrokes Interface.

Syntax

HRESULT Item(
  [in]          VARIANT     Identifier,
  [out, retval] IInkStrokes **Strokes
);

Parameters

[in] Identifier

The numeric index or string name of the InkStrokes Collection to return from the IInkCustomStrokes collection.

[out, retval] Strokes

When this method returns, contains a pointer to the InkStrokes Collection at the location specified within the IInkCustomStrokes Interface.

Return value

This method can return one of these values.

HRESULT Value 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 identifier doesn't match any existing member of the collection.

This method takes an input argument of type VARIANT. The subtype of this variable must be BSTR or Long.

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

IInkCustomStrokes Interface

InkStrokes Collection

Item Method [InkStrokes Collection]