IInkOverlay::SetGestureStatus method (msinkaut.h)

Sets the interest of the object or control in a known gesture.

Syntax

HRESULT SetGestureStatus(
  [in] InkApplicationGesture Gesture,
  [in] VARIANT_BOOL          Listen
);

[in] Gesture

The gesture that you want to set the status of.

[in] Listen

VARIANT_TRUE if the gesture is being used or VARIANT_FALSE if it is being ignored.

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contained an invalid pointer.
E_INK_INVALID_MODE	InkCollector collection mode must be in gesture mode.
E_INK_EXCEPTION	An exception occurred.
TPC_S_TRUNCATED	Unsupported gesture.
E_INVALIDARG	The flag is invalid.
E_OUTOFMEMORY	Cannot allocate memory operation.

To get the interest of the object or control in a known gesture, call the GetGestureStatus method.

The IAG_AllGestures gesture ID is not supported by the InkEdit control and returns an error. Passing invalid Gesture IDs does not return an error for InkEdit, but fails for InkCollector, InkOverlay, and InkPicture.

For the InkEdit control, this method should only be called if the Status property returns IES_Idle.

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