IInkDivisionUnit::RecognitionString property

Gets the recognized text for the InkStrokes collection in the IInkDivisionUnit object.

This property is read-only.

Syntax

HRESULT get_RecognitionString(
  [out, retval] BSTR *RecoString
);

Property value

The recognized text for the InkStrokes collection in the IInkDivisionUnit object or NULL for drawing elements.

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

Error codes

Name Meaning
S_OK

Success.

E_POINTER

A parameter contains an invalid pointer.

E_OUTOFMEMORY

Unable to allocate memory to complete the operation.

Remarks

The following table describes the recognized text for each type of IInkDivisionUnit object.

DivisionUnit Type RecognizedText Value
IDT_Segment

The top alternate for the recognition segment.

IDT_Line

The RecognizedText for each segment in the line, separated by spaces.

IDT_Paragraph

The RecognizedText for each line in the paragraph, separated by new line characters.

IDT_Drawing

NULL.

 

The RecognitionString property and the DivisionUnit.ToString method return the identical strings.

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Msinkaut15.h (also requires Msinkaut15_i.c)

Library

Inkdiv.dll

See also

IInkDivisionUnit Interface

InkDivisionType Enumeration

ToString Method