Share via


IInkRecognitionAlternate::GetStrokesFromStrokeRanges

4/8/2010

Returns the smallest IInkStrokes collection that contains a known input IInkStrokes collection and for which the IInkRecognizer object can provide IInkRecognitionAlternates.

Syntax

HRESULT GetStrokesFromStrokeRanges (
  [in] IInkStrokes *strokes,
  [out, retval] IInkStrokes **GetStrokesFromStrokeRanges
);

Parameters

  • strokes
    The collection of stroke objects to use to find the smallest stroke collection of the recognition result alternate that contains this collection.
  • GetStrokesFromStrokeRanges
    Returns the smallest collection of strokes that contains a known input collection of strokes and for which the recognizer can provide alternates.

Return Value

HRESULT value Description

S_OK

Success.

E_POINTER

A parameter contained an invalid pointer.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INK_MISMATCHED_INK_OBJECT

The strokes parameter is associated with a different Ink object.

E_FAIL

An unspecified error occurred.

Remarks

The returned collection may match the input collection, or it may be larger if the input collection matches only part of the smallest recognition result that includes all of the input strokes.

This method is most useful for single-click word selection. For example, to return the strokes that make up the word you clicked, you can click a stroke, call the IInkStrokeDisp::HitTestCircle method to retrieve the stroke that was clicked, and then call GetStrokesFromStrokeRanges.

The stroke ranges are valid until the IInkDisp object is modified.

Requirements

Header msinkaut.h
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later

See Also

Concepts

Windows Mobile Ink Reference