Export (0) Print
Expand All

InkCollector.NewPackets event

Applies to: desktop apps only

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]

Specifies the IInkStrokeDisp object.

PacketCount [in]

The number of packets received for a IInkStrokeDisp object.

PacketData [in, out]

When this method returns, contains 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.

TThis 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

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkCollector Class
NewInAirPackets Event
IInkCursor Interface
IInkStrokeDisp Interface

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2015 Microsoft