Export (0) Print
Expand All

InkEdit.SetGestureStatus method

Applies to: desktop apps only

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

Syntax

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

Parameters

Gesture [in]

The IInkGesture object that you want the status of.

Listen [in]

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

Minimum supported server

None supported

Header

Inked.h (also requires inked_i.c)

Library

InkEd.dll

See also

InkEdit
Gesture Event
GetGestureStatus Method [InkEdit Control]
InkApplicationGesture Enumeration

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft