InkOverlay.SetGestureStatus method

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

Syntax


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

Parameters

Gesture [in]

The gesture that you want to set the status of.

Listen [in]

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

Return value

This method can return one of these values.

Return codeDescription
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.

 

Remarks

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.

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkOverlay Class
Gesture Event
GetGestureStatus Method
InkApplicationGesture Enumeration

 

 

Show: