Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IInkRecognitionResult::TopString property

Applies to: desktop apps only

Gets the result text for the TopAlternate property.

This property is read-only.

Syntax

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

Property value

The result text for the TopAlternate property.

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

Error codes

NameMeaning
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 occurred while processing.

E_OUTOFMEMORY

Cannot allocate memory to complete the operation.

Remarks

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

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

IInkRecognitionResult Interface
ModifyTopAlternate Method
TopAlternate Property

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.