Share via

TopString Property

  • Article

TopString Property

Gets the result text for the TopAlternate property.

Declaration

[C++]

[C++]
[propget] HRESULT get_TopString([out,retval]BSTR* TopString);

[Microsoft® Visual Basic® 6.0]

[Visual Basic]
Public Property Get TopString() As String

Property Value

BSTR The result text for the TopAlternate property.

This property is read-only.

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

Return Value

HRESULT value Description
S_OK Success.
TPC_S_TRUNCATED The string is truncated to fit in the buffer.
E_POINTER The TopString parameter is an invalid pointer.
E_INK_EXCEPTION An exception occurs inside the method.
E_OUTOFMEMORY Cannot allocate memory to complete the operation.

Remarks

Note: The result text for the TopString property changes if a call to the ModifyTopAlternateMethod method causes a change to the TopAlternate property.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example copies the text of the best alternate of a IInkRecognitionResult, theRecognitionResult, into a text box, theTextBox.

[Visual Basic]
theTextBox.Text = theRecognitionResult.TopString

Applies To