IInkEdit::SetGestureStatus method

Modifies the interest of the InkEdit control in a known application gesture.

Syntax

HRESULT SetGestureStatus(
  InkApplicationGesture Gesture,
  VARIANT_BOOL          Listen
);

Parameters

Gesture

The IInkGesture object that you want the status of.

Listen

VARIANT_TRUE to indicate that the InkEdit control uses the application gesture; otherwise, VARIANT_FALSE.

Return value

This method can return one of these values.

Return code Description
S_OK
Success.
E_POINTER
The input parameter was incorrect.
E_INK_INVALID_MODE
InkEdit status must be IES_Idle.
E_INK_EXCEPTION
An exception occurred.
TPC_S_TRUNCATED
Unsupported gesture.
E_INVALIDARG
The flag is invalid.
E_OUTOFMEMORY
Cannot allocate memory operation.

Remarks

The IAG_AllGestures gesture is not supported by the InkEdit control and returns an error. Passing invalid gesture identifiers does not return an error.

This method should only be called if the Status property returns IES_Idle.

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

Requirements

   
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

See also

Gesture Event

GetGestureStatus Method [InkEdit Control]

IInkEdit

InkApplicationGesture Enumeration

InkEdit