Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

This method returns a collection of variants of a word’s recognition in the current position inside the text of a paragraph. The method returns zero for non-printable characters (spaces, carriage returns, etc.) and characters that were not recognized but added to the text during explicit editing. Zero is also returned if the text was recognized by one of the previous ABBYY FineReader Engine versions. If the IRecognizerParams::SaveWordRecognitionVariants property is set to FALSE the return collection contains one element; otherwise, the collection contains no less than one element and the variants are ordered from the best to the worst, determined by the internal estimation mechanism.

​
Syntax

​
C++

HRESULT GetWordRecognitionVariants(
  int                        Position,
  IWordRecognitionVariants** Result
);

​
C#

IWordRecognitionVariants GetWordRecognitionVariants( int Position );

​
Visual Basic .NET

Function GetWordRecognitionVariants(Position As Integer) As IWordRecognitionVariants

​
Parameters

Position [in] This variable contains the index of the character inside the paragraph. This index must be in the range from zero to the length of the paragraph (the IParagraph::Length property). When the length of the paragraph is passed into this method, this property refers to the parameters that would have received the character if it were inserted at the end of the paragraph. Result [out, retval] A pointer to IWordRecognitionVariants* pointer variable that receives the interface pointer to the WordRecognitionVariants output object.

​
Return values

This function has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

​
See also

Paragraph ICharParams::WordRecognitionVariants Using Voting API