IInkCollector::GetGestureStatus method (msinkaut.h)

  • Article

Indicates 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

[in] Gesture

Sets the gesture that you want the status of.

[out, retval] Listening

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

Return value

This method can return one of these values.

Return code 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 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

Requirement Value
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

IInkCollector

InkApplicationGesture Enumeration

InkCollector Class

SetGestureStatus Method