Stroke.GetPacketData Method (Int32, Int32)

Article
12/12/2007

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 int[] GetPacketData (
    int index, 
    int count
)

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

Not applicable.

Parameters

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

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

Return Value

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.

Example

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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via