Item Method [InkStrokes Collection]
Item Method [InkStrokes Collection] |
Returns the IInkStrokeDisp object at the specified index within the InkStrokes collection.
Declaration
[C++]
HRESULT Item (
[in] long index,
[out, retval] IInkStrokeDisp** Stroke
);
[Microsoft® Visual Basic® 6.0]
Public Function Item( _
index As Long _
) As IInkStrokeDisp
Parameters
index
[in] The zero-based index of the IInkStrokeDisp object to get.
Stroke
[out] Returns the IInkStrokeDisp object at the specified index within the InkStrokes collection.
Return Value
| 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. |
Remarks
An error occurs if the index doesn't match any existing member of the collection.
Example
[Visual Basic 6.0]
This Visual Basic 6.0 example gets the first IInkStrokeDisp object from the Strokes property of an InkDisp object.
Dim theFirstStroke As IInkStrokeDisp
Set theFirstStroke = theInk.Strokes.Item(0)