IInkRecognizer::get_PreferredPacketDescription method (msinkaut.h)

Article
04/02/2021

Gets an array of globally unique identifiers (GUIDs) that represents the preferred packet properties for the recognizer.

This property is read-only.

Syntax

HRESULT get_PreferredPacketDescription(
  VARIANT *PreferredPacketDescription
);

Parameters

PreferredPacketDescription

Return value

None

Remarks

This property describes the contents of a packet and does not allow access to the data that the packet contains.

This property lists the packet properties that the recognizer uses to complete recognition. For all of the Microsoft recognizers, the PreferredPacketDescription property refers to the data describing (x, y) coordinates within an IInkStrokeDisp object. This data is represented by the X and Y fields of the packet property constants. A packet contains this point data as well as other data that is related to that stroke, such as the pressure of the pen that made the stroke, the angle of the pen, and so on. The Microsoft recognizers ignore pressure, tilt, and other packet properties.

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