Stroke.GetPacketData Method (Int32, Int32)

Article
10/19/2012

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

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Function GetPacketData ( _
    index As Integer, _
    count As Integer _
) As Integer()
'Usage
Dim instance As Stroke 
Dim index As Integer 
Dim count As Integer 
Dim returnValue As Integer()

returnValue = instance.GetPacketData(index, _
    count)

public int[] GetPacketData(
    int index,
    int count
)

public:
array<int>^ GetPacketData(
    int index, 
    int count
)

public function GetPacketData(
    index : int, 
    count : int
) : int[]

Parameters

index
Type: System.Int32

The starting point of the zero-based index to a packet within the stroke.

count
Type: System.Int32

The number of point packet data sets to return, starting with the packet specified in the index parameter.

Return Value

Type: array<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

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

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

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)

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via