IInkDisp::Strokes

  • Article

4/8/2010

Gets the collection of IInkStrokes that are contained in an IInkDisp object or used to create an object.

Syntax

[propget] HRESULT get_Strokes ([out, retval] IInkStrokes** Strokes);

Return Value

  • Strokes
    The collection of IInkStrokes that are contained in an object or used to create an object.

    This property is read–only.

Return Value

  • S_OK
    Success.
  • E_POINTER
    A parameter contained an invalid pointer.
  • E_INK_INCOMPATIBLE_OBJECT
    The Strokes parameter does not point to a compatible IInkDisp object.
  • E_INK_EXCEPTION
    An exception occurred inside the method.
  • E_OUTOFMEMORY
    Unable to allocate memory to complete the operation.
  • E_UNEXPECTED
    Unexpected parameter or property type.

Remarks

The collection of strokes may be the copies of the strokes contained in an IInkDisp object or the strokes that were used to create the object or collection.

Note

The Strokes property for the IInkDisp object does not return the actual collection that the InkDisp object works with, but instead returns a copy. For example, this means that adding or removing strokes to this collection does not affect the IInkDisp object's strokes. To add or remove strokes, use IInkDisp methods such as IInkDisp::AddStrokesAtRectangle, IInkDisp::DeleteStroke, and IInkDisp::DeleteStrokes. However, each stroke in the collection is a reference to the original IInkStrokeDisp object.

Requirements

Header msinkaut.h
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later

See Also

Concepts

Windows Mobile Ink Reference