Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
4/8/2010

Changes the top IInkRecognitionAlternatefor the IInkRecognitionResultobject.

Syntax 

HRESULT ModifyTopAlternate( 
  [in] IInkRecognitionAlternate *Alternate)
);

Parameters

Alternate

The IInkRecognitionAlternateobject to use to modify the IInkRecognitionResultobject.

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::TopStringproperty corresponds to the IInkRecognitionResult::TopAlternateproperty; 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 IInkRecognitionAlternateobjects that can be used to modify the IInkRecognitionResultobject, call the IInkRecognitionResult::GetAlternatesFromSelectionmethod.

The alternate used in this method can be a word alternate within an entire sentence. For example, calling the ModifyTopAlternatemethod on an alternate obtained by calling GetAlternatesFromSelection(0,5)for "Hello World" changes "Hello" and leaves "World" unaltered.

Note:
A call to the ModifyTopAlternatemethod may modify the TopStringand TopAlternateproperties of the IInkRecognitionResultobject.

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