IInkStrokeDisp::GetPoints method (msinkaut.h)

Retrieves the points that make up a stroke.

Syntax

HRESULT GetPoints(
  [in, optional] long    Index,
  [in, optional] long    Count,
  [out, retval]  VARIANT *Points
);

Parameters

[in, optional] Index

Optional. The starting index within the array of points that make up the stroke. The default value ISC_FirstElement, defined in the InkSelectionConstants enumeration type, specifies the first point.

[in, optional] Count

Optional. The number of points to return. The default value ISC_AllElements, defined in the InkSelectionConstants enumeration type, specifies all of the points that make up the stroke data.

[out, retval] Points

When this method returns, contains the array of points from the stroke.

For more information about the VARIANT structure, see Using the COM Library.

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_OUTOFMEMORY	Cannot allocate memory for the points.
E_INVALIDARG	Invalid index (out of range).
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

IInkStrokeDisp Interface

ItemSelectionConstants Enumeration