InkOverlay.GetGestureStatus method

Retrieves a value that determines whether the InkCollector or InkOverlay object is interested in a particular application gesture.

Syntax


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

Parameters

Gesture [in]

The gesture that you want the status of.

Listening [out, retval]

VARIANT_TRUE if the InkCollector control has interest in a particular application gesture; otherwise, VARIANT_FALSE.

This method returns a value that indicates the interest of the InkCollector or InkOverlay object in a known application gesture. If VARIANT_TRUE, the InkCollector or InkOverlay object is interested in the gesture and the Gesture event of the InkCollector or InkOverlay object fires when the gesture is recognized.

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

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 IAG_AllGestures.

To set the interest of the InkCollector or InkOverlay object in a particular gesture, call the InkCollector or InkOverlay object's SetGestureStatus method.

Note  By default, the InkCollector and InkOverlay objects do not have interest in any of the application gestures.
 

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
InkApplicationGesture Enumeration
Gesture Event
SetGestureStatus Method

 

 

Show: