IInkRecognitionAlternate::AlternatesWithConstantPropertyValues method (msinkaut.h)

Article
10/13/2021

Retrieves a IInkRecognitionAlternates collection, which are a division of the IInkRecognitionAlternate object on which this method is called.

Syntax

HRESULT AlternatesWithConstantPropertyValues(
  [in]          BSTR                      PropertyType,
  [out, retval] IInkRecognitionAlternates **AlternatesWithConstantPropertyValues
);

Parameters

[in] PropertyType

Specifies a string value that identifies the property. For a list of the properties that can be used, see RecognitionProperty.

For more information about the BSTR data type, see Using the COM Library.

[out, retval] AlternatesWithConstantPropertyValues

When this method returns, contains an IInkRecognitionAlternates collection which is made up of a division of the alternate on which this method is called. Each IInkRecognitionAlternate object in the collection contains adjacent recognition segments which have the same property value for the propertyType parameter.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contained an invalid pointer.
E_INVALIDARG	The recognition range is invalid.
E_INK_EXCEPTION	An exception occurred while processing.
E_OUTOFMEMORY	Cannot allocate memory to complete the operation.

Remarks

Each alternate in the collection contains adjacent recognition segments which have the same property value for the property passed into the method.

For example, you can return alternates that divide the original alternate by:

Level of confidence boundaries-strong, intermediate, or poor-in the recognition result.
Line boundaries.
Recognition segment boundaries.

For a complete list of property types, see RecognitionProperty.

Note The recognizer determines the segmentation of strokes into the recognition segments. Some recognition segments, such as spaces, may correspond to an empty InkStrokes collection.

Note The recognizer determines the ordering of the recognition segments. Therefore, adjacent recognition segments may be based on the order in which the ink was drawn or based on location, such as whether it is positioned left-to-right, positioned top-to-bottom, and so on.

The ConfidenceAlternates property is an alternative to the AlternatesWithConstantPropertyValues method, where ConfidenceLevel is the RecognitionProperty that separates the alternates in the returned recognition alternates collection.

The LineAlternates property is an alternative to the AlternatesWithConstantPropertyValues method, where LineNumber is the RecognitionProperty that separates the alternates in the returned recognition alternates collection.

Note The AlternatesWithConstantPropertyValues method, the LineAlternates property, and the ConfidenceAlternates property of the IInkRecognitionAlternate object function differently than the AlternatesFromSelection method of the IInkRecognitionResult object. AlternatesFromSelection returns a collection of alternates for the requested segments of the recognition result.

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