Edit

Share via

IInkStrokeDisp::HitTestCircle method (msinkaut.h)

  • Article

Determines whether a stroke is either completely inside or intersected by a given circle.

Syntax

HRESULT HitTestCircle(
  [in]          long         X,
  [in]          long         Y,
  [in]          float        Radius,
  [out, retval] VARIANT_BOOL *Intersects
);

Parameters

[in] X

The x-position of the center of the hit-test circle in ink space coordinates.

[in] Y

The y-position of the center of the hit-test circle in ink space coordinates.

[in] Radius

The radius of the circle to use in the hit test.

[out, retval] Intersects

VARIANT_TRUE if the stroke intersects or is inside the circle; otherwise, VARIANT_FALSE

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_EXCEPTION
 An exception occurred inside the method.
E_UNEXPECTED
 Unexpected parameter or property type.

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

GetRectangleIntersections Method

HitTest(Point, Single) Method

IInkStrokeDisp Interface

NearestPoint Method [IInkStrokeDisp Interface]