IInkGesture::GetHotPoint method (msinkaut.h)

  • Article

Gets the hot point of the gesture, in ink space coordinates.

Syntax

HRESULT GetHotPoint(
  [in, out] long *X,
  [in, out] long *Y
);

Parameters

[in, out] X

The X-value of the hot point, in ink space coordinates.

[in, out] Y

The Y-value of the hot point, in ink space coordinates.

Return value

This method can return one of these values.

Return code Description
S_OK
 Error information is provided.
E_POINTER
 A parameter contained an invalid pointer.
E_INK_EXCEPTION
 An exception occurred while processing.

Remarks

The hot point is the one distinguishing point of a gesture. It is usually the point of the angle in a gesture or the point at which the gesture is intended to occur in relation to the content around it. If there is no discernable hot point for a known gesture, the starting point of the gesture is the hot point.

For example, the hot point of the Check gesture is the point of the angle, and the hot point of the Curlicue gesture is the start of the stroke that is the gesture.

For more information about how a hot point is used, see Using 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

IInkGesture Interface

Using Gestures