Capabilities Property

Capabilities Property

Gets the capabilities of the IInkRecognizer object.

Declaration

[C++]

[propget] HRESULT get_Capabilities ([out, retval]
    InkRecognizerCapabilities* Capabilities);

[Microsoft® Visual Basic® 6.0]

Public Property Get Capabilities() As InkRecognizerCapabilities

Property Value

InkRecognizerCapabilities Values that define the capabilities of the recognizer.

This property is read-only.

Return Value

HRESULT value Description
S_OK Success.
E_POINTER The parameter is an invalid pointer.
E_INK_EXCEPTION An exception occurred while processing.

Remarks

A recognizer's capabilities are defined in the InkRecognizerCapabilities enumeration, and they include whether the recognizer supports character Autocomplete; whether it supports free, lined, or boxed input; and so on. For a complete list of recognizer capabilities, see the InkRecognizerCapabilities enumeration.

To determine if a recognizer has a particular capability, use a bitwise comparison operator to check for that capability.

For information about how to request various recognizer capabilities, or modes, see the Guide property of the RecognizerContext object.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example determines if a recognizer supports a particular capability.

'...
Dim isArbitraryAngleSupported As Boolean
isArbitraryAngleSupported = False
Dim theCapabilities As InkRecognizerCapabilities
theCapabilities = theRecognizer.Capabilities
If (IRC_ArbitraryAngle And theCapabilities) <> 0 Then
    isArbitraryAngleSupported = True
End If

Applies To