InkOverlay.NewInAirPackets event

Occurs when an in-air packet is seen.

Syntax

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

Parameters

Cursor [in]

The IInkCursor object that generated the NewInAirPackets event.

PacketCount [in]

The number of in-air packets received.

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

An in-air packet is created when a user moves a pen near the tablet and the cursor is within the ink collector object's window or the user moves a mouse within the ink collector object's associated window. NewInAirPackets events are generated rapidly, and the 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_ICENewInAirPackets.

The NewInAirPackets event is fired even when in select or erase mode, not just when inserting ink. This requires that you monitor the editing mode (which you are responsible for setting) and be aware of the mode before interpreting the event. The advantage of this requirement is greater freedom to innovate on the platform through greater awareness of platform events.

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.

Requirements

See also

InkOverlay Class

DesiredPacketDescription Property

NewPackets Event

IInkCursor Interface