IInkDivisionResult::ResultByType method (msinkaut15.h)

Article
02/22/2024

Gets the requested structural units of the analysis results for an IInkDivisionUnits collection.

Syntax

HRESULT ResultByType(
  [in]          InkDivisionType   divisionType,
  [out, retval] IInkDivisionUnits **InkDivisionUnits
);

Parameters

[in] divisionType

The InkDivisionType enumeration value that indicates the structural units to return.

[out, retval] InkDivisionUnits

A pointer to the IInkDivisionUnits collection that contains the requested structural units of the analysis results.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contains an invalid pointer.
E_INVALIDARG	A parameter contains an invalid value.
E_UNEXPECTED	Unexpected parameter or property type.
E_INK_EXCEPTION	An exception occurred inside the method.

Remarks

This method returns a new IInkDivisionUnits collection each time the method is called.

If no structural units of the requested type exist in the IInkDivisionResult object, then this method returns an empty IInkDivisionUnits collection.

If you define a class that implements this interface, the new class will not interact correctly with the Tablet PC application programming interfaces (APIs).

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut15.h
Library	Inkdiv.dll