Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

InkOverlay.DesiredPacketDescription property

Gets or sets the desired packet description of the InkCollector.

This property is read/write.


HRESULT put_DesiredPacketDescription(
  [in]          BSTR *PacketGuids

HRESULT get_DesiredPacketDescription(
  [out, retval] BSTR **PacketGuids

Property value

An array of PacketProperty objects that specify the properties of the packets that the InkCollector collects. The default value is {X, Y, NormalPressure}

For more information about the BSTR data type, see Using the COM Library.

Error codes




An unspecified error occurred.


Cannot allocate the memory necessary to complete this operation.


An exception occurred inside the method.


The parameter must be an array of BSTRs.


The description is an array of globally unique identifiers (GUIDs) from the PacketProperty object.

In multitablet mode, this is the packet description for all of the tablet devices. If any of the devices don't support a known packet description property, the property data is not returned.

By default, DesiredPacketDescription contains STR_GUID_X, STR_GUID_Y, and STR_GUID_NORMALPRESSURE from the PacketProperty object. If you set DesiredPacketDescription to anything else, STR_GUID_BUTTONPRESSURE only for example, STR_GUID_X and STR_GUID_Y is also added. A get of DesiredPacketDescription returns {X,Y,ButtonPressure} and not {ButtonPressure}.

When DesiredPacketDescription is set to something that includes STR_GUID_PAKETSTATUS, the packet status is added in the third position. For example, if you set DesiredPacketDescription to (a, b, c, d, PacketStatus, e, f), when you get DesiredPacketDescription the result is (X, Y, PacketStatus, a, b, c, d, e, f).

Changes to this property do not affect incoming packet data until the Enabled property changes from FALSE to TRUE.


Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported


Msinkaut.h (also requires Msinkaut_i.c)



See also

InkOverlay Class
PacketPropertyGuids Constants
IInkTablet Interface



Community Additions

© 2015 Microsoft