IContextNode::GetStrokePacketDescriptionById method

Retrieves an array containing the packet property identifiers for the specified stroke.

Syntax

HRESULT GetStrokePacketDescriptionById(
  [in]      LONG  lStrokeId,
  [in, out] ULONG *pulStrokePacketDescriptionCount,
  [out]     GUID  **ppStrokePacketDescriptionGuids
);

Parameters

lStrokeId [in]

The identifier for the stroke.

pulStrokePacketDescriptionCount [in, out]

The number of packet properties in each packet.

ppStrokePacketDescriptionGuids [out]

An array containing the packet property identifiers.

Return value

For a description of the return values, see Classes and Interfaces - Ink Analysis.

Remarks

Caution

To avoid a memory leak, use CoTaskMemFree to release the memory from *ppStrokePacketDescriptionGuids when you no longer need the information.

*ppStrokePacketDescriptionGuids contains the globally unique identifiers (GUIDs) that describe the types of packet data included for each point in the stroke. For a complete list of available packet properties, see PacketPropertyGuids Constants.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	IACom.h (also requires IACom_i.c)
DLL	IACom.dll

See also

IContextNode

IContextNode::GetStrokePacketDataById

Ink Analysis Reference