InkEdit.GetGestureStatus method
Indicates whether the InkEdit control is interested in a particular application gesture.
Syntax
HRESULT GetGestureStatus(
[in] InkApplicationGesture Gesture,
[out, retval] VARIANT_BOOL *pListen
);
Parameters
- Gesture [in]
-
The gesture that you want the status of.
- pListen [out, retval]
-
VARIANT_TRUE if the InkEdit control has interest in the gesture and the Gesture event of the InkEdit control fires when the gesture is recognized. VARIANT_FALSE if the InkEdit control has no interest in the gesture.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
Success. |
|
Input parameter was incorrect. |
|
Collection mode must be in gesture-mode. |
|
Cannot allocate memory to perform action. |
|
An exception occurred. |
|
The flag is invalid. |
Remarks
This method throws an exception if the gesture parameter is set to the IAG_AllGestures gesture.
To set the interest of the InkEdit control in a particular gesture, call the SetGestureStatus method.
Requirements
|
Minimum supported client |
Windows XP Tablet PC Edition [desktop apps only] |
|---|---|
|
Minimum supported server |
None supported |
|
Header |
|
|
Library |
|
See also
- InkEdit
- InkApplicationGesture Enumeration
- Gesture Event [InkEdit Control]
- SetGestureStatus Method [InkEdit Control]