Share via

Stroke.GetPacketData Method

  • Article

Stroke.GetPacketData Method

Returns the packet data for a range of packets within the Stroke object.

Definition

Visual Basic .NET Public Function GetPacketData( _
ByVal index As Integer, _
ByVal count As Integer _
) As Integer()
C# public int[] GetPacketData(
int index,
int count
);
Managed C++ public: int* GetPacketData(
int *index,
int *count
) __gc[];

Parameters

index System.Int32. The starting point of the zero-based index to a packet within the stroke.
count System.Int32. The number of point packet data sets to return, starting with the packet specified in the index parameter.

Return Value

System.Int32[]. Returns a signed 32-bit integer array containing the packet data for the requested points in the Stroke object. The array contains the data for the first point, then the data for the second point, and so on.

Remarks

If the number of packets in the Stroke object is less than the sum of the index and count parameters, then the returned array of data contains packet information for fewer points than the count requested.

To retrieve the description of the packet data, use the Stroke object's PacketDescription property. This property returns an array of globally unique identifiers (GUIDs) that indicate which property values are returned by the GetPacketData method for each point. The PacketProperty structure contains the available packet property GUIDs.

Examples

[C#]

This C# example gets the packet data for the first point in the Stroke object, theStroke.

int[] thePacketData = theStroke.GetPacketData(0, 1);

[VB.NET]

This Microsoft® Visual Basic® .NET example gets the packet data for the first point in the Stroke object, theStroke.

Dim thePacketData() As Integer = theStroke.GetPacketData(0, 1)

See Also