IInkRecognitionResult::ModifyTopAlternate
4/8/2010
Changes the top IInkRecognitionAlternate for the IInkRecognitionResult object.
Syntax
HRESULT ModifyTopAlternate(
[in] IInkRecognitionAlternate *Alternate)
);
Parameters
- Alternate
The IInkRecognitionAlternate object to use to modify the IInkRecognitionResult object.
Return Value
| HRESULT value | Description |
|---|---|
S_OK |
Success. |
E_INVALIDARG |
The recognition range is invalid. |
E_INK_EXCEPTION |
An exception occurred while processing. |
E_POINTER |
A parameter contained an invalid pointer. |
E_OUTOFMEMORY |
Cannot allocate memory to complete the operation. |
Remarks
By default, the IInkRecognitionResult::TopString property corresponds to the IInkRecognitionResult::TopAlternate property; however, you can use this method to use alternates other than the top alternate in the result. When you choose an alternate other than the top alternate, you are essentially choosing a different path through the lattice of alternates that are associated with the results.
To retrieve the IInkRecognitionAlternate objects that can be used to modify the IInkRecognitionResult object, call the IInkRecognitionResult::GetAlternatesFromSelection method.
The alternate used in this method can be a word alternate within an entire sentence. For example, calling the ModifyTopAlternate method on an alternate obtained by calling GetAlternatesFromSelection(0,5) for "Hello World" changes "Hello" and leaves "World" unaltered.
Note
A call to the ModifyTopAlternate method may modify the TopString and TopAlternate properties of the IInkRecognitionResult object.
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 |