GetGestureStatus Method

  • Article

GetGestureStatus Method

Returns whether the InkCollector or InkOverlay object is interested in a particular application gesture.

Declaration

[C++]

[C++]
HRESULT GetGestureStatus (
    [in] InkApplicationGesture gesture,
    [out, retval] VARIANT_BOOL *Listening
);

[Microsoft® Visual Basic® 6.0]

[Visual Basic]
Public Function GetGestureStatus( _
    gesture As InkApplicationGesture _
) As Boolean

Parameters

gesture

[in] The gesture that you want the status of.

Return Value

This method returns a value that indicates the interest of the InkCollector or InkOverlay object in a known application gesture. If TRUE, the InkCollector or InkOverlay object is interested in the gesture and the Gesture event of the InkCollector or InkOverlay object fires when the gesture is recognized.

HRESULT value Description
S_OK Success.
E_POINTER A parameter contained an invalid pointer.
E_INK_INVALID_MODE Collection mode must be in gesture-mode.
E_OUTOFMEMORY Cannot allocate memory to perform action.
E_INK_EXCEPTION An exception occurred.
E_INVALIDARG The flag is invalid.

Remarks

This method throws an exception if the gesture parameter is set to IAG_AllGestures.

To set the interest of the InkCollector or InkOverlay object in a particular gesture, call the InkCollector or InkOverlay object's SetGestureStatus method.

Note: By default, the InkCollector and InkOverlay objects do not have interest in any of the application gestures.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example sets and then tests the interest status for the IAG_ArrowLeft on the InkCollector object, theInkCollector, which should immediately put up a message box containing the value TRUE.

[Visual Basic]
Dim theInkCollector As InkCollector

Private Sub Form_Load()
    Set theInkCollector = New InkCollector
    theInkCollector.hWnd = Me.hWnd
    theInkCollector.Enabled = True
    theInkCollector.SetGestureStatus IAG_ArrowLeft, True
    MsgBox theInkCollector.GetGestureStatus(IAG_ArrowLeft)
End Sub

Applies To