IInkEdit::GetGestureStatus method (inked.h)

Article
02/22/2024

Indicates whether the InkEdit control is interested in a particular application gesture.

Syntax

HRESULT GetGestureStatus(
  [in]          InkApplicationGesture Gesture,
  [out, retval] VARIANT_BOOL          *pListen
);

Parameters

[in] Gesture

The gesture that you want the status of.

[out, retval] pListen

VARIANT_TRUE if the InkEdit control has interest in the gesture and the Gesture event of the InkEdit control fires when the gesture is recognized. VARIANT_FALSE if the InkEdit control has no interest in the gesture.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	Input parameter was incorrect.
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 the IAG_AllGestures gesture.

To set the interest of the InkEdit control in a particular gesture, call the SetGestureStatus method.

Note By default, the InkEdit control has interest in the following gestures:

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	inked.h
Library	InkEd.dll