IInkPicture::GetGestureStatus method (msinkaut.h)

Retrieves a value that indicates whether the InkPicture control has interest in a particular application gesture.

Syntax

HRESULT GetGestureStatus(
  InkApplicationGesture Gesture,
  VARIANT_BOOL          *Listening
);

Parameters

Gesture

The gesture that you want the status of.

Listening

VARIANT_TRUE if the InkPicture control has interest in the gesture and the Gesture Event fires when the gesture is recognized. VARIANT_FALSE if the InkPicture control has no interest in the gesture, and the strokes that were recognized as a gesture remain as IInkStrokeDisp objects.

Return value

This method can return one of these values.

HRESULT value Description
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 InkPicture control in a particular gesture, call the SetGestureStatus Method.

Note  By default, the InkPicture control does not have interest in any application gesture.
 

Requirements

   
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

See also

Gesture Event

IInkPicture

InkApplicationGesture Enumeration

InkPicture

SetGestureStatus Method