PacketDescription Property

  • Article

PacketDescription Property

Gets an array of globally unique identifiers (GUIDs) that describes the types of packet data stored in the IInkStrokeDisp object.

Declaration

[C++]

[C++]

[propget] HRESULT get_PacketDescription (
    [out, retval] VARIANT* PacketDescription
);

[Microsoft® Visual Basic® 6.0]

[Visual Basic]

Public Property Get PacketDescription() As Variant

Property Value

VARIANT A BSTR array representing the GUIDs of the types of packet data stored in the IInkStrokeDisp object. The GUIDs are represented in the following format (including curly braces).

{dfc71f44-354b-4ca1-93d7-7459410b6343}

This property is read-only.

For more information about the VARIANT and BSTR data types, see Using the Automation Library.

Return Value

HRESULT value Description
S_OK Success.
E_POINTER The parameter pointer was invalid.
E_INK_EXCEPTION An exception occurred inside the method.
E_OUTOFMEMORY Cannot allocate the memory necessary to complete this operation.

Remarks

For a complete list of available packet properties, see the PacketProperty constants.

In Visual Basic 6.0, if you try to access the PacketDescription parameter's GUID array data by using the IDispatch interface, run-time error 451 occurs. This error occurs because Visual Basic treats the "(0)" in "theStrokes.PacketDescription(0)" as a parameter being passed to the PacketDescription property rather than as an index into the array contained in the PacketDescription parameter. To avoid this error, you can assign the array to a temporary variable dimensioned as a BSTR array and then index the variable or you can declare the containing object directly with a Dim x As Type statement instead of through the IDispatch interface using a CreateObject() call.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example returns the packet data GUID of an IInkStrokeDisp object, theStroke.

[Visual Basic]

Dim thePacketDescription(0) As Variant
thePacketDescription(0) = theStroke.PacketDescription(0)

Applies To