InkPicture.NewPackets event

Article
04/27/2021

Occurs when the ink collector receives a packet.

Syntax

void NewPackets(
  [in]      IInkCursor     *Cursor,
  [in]      IInkStrokeDisp *Stroke,
  [in]      long           PacketCount,
  [in, out] VARIANT        *PacketData
);

Parameters

Cursor [in]

The IInkCursor object that generated the NewInAirPackets event.

Stroke [in]

The IInkStrokeDisp object.

PacketCount [in]

The number of packets received for a IInkStrokeDisp object.

PacketData [in, out]

An array that contains the selected data for the packet.

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

Return value

This event does not return a value.

Remarks

Packets are received while a stroke is being collected. Packet events occur rapidly, and a NewPackets event handler must be fast or performance suffers.

This event method is defined in the _IInkCollectorEvents, _IInkOverlayEvents, and _IInkPictureEvents dispatch-only interfaces (dispinterfaces) with an ID of DISPID_ICENewPackets.

This event should be used carefully as it could have an adverse effect on ink performance if too much code is executed in the event handlers.

To set which properties are contained in this array, use the DesiredPacketDescription property of the ink collector object. The array that the PacketData parameter returns contains the data for those properties.

Note

Although you can modify the packet data, these modifications are not persisted or used.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	Msinkaut.h (also requires Msinkaut_i.c)
Library	InkObj.dll