IInkDisp::CreateStrokes method (msinkaut.h)

Article
10/13/2021

Creates a new InkStrokes collection from existing IInkStrokeDisp objects.

Syntax

HRESULT CreateStrokes(
  [in, optional] VARIANT     StrokeIds,
  [out, retval]  IInkStrokes **Strokes
);

Parameters

[in, optional] StrokeIds

Optional. Specifies an array of stroke IDs that exist in the InkDisp object. The strokes with these IDs are added to a new InkStrokes collection. The default value is NULL.

For more information about the VARIANT structure, see Using the COM Library.

[out, retval] Strokes

When this method returns, contains a pointer to a new InkStrokes collection.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contained an invalid pointer.
E_INVALIDARG	Invalid VARIANT type (only VT_ARRAY \| VT_I4 supported).
E_INK_EXCEPTION	An exception occurred inside the method.
E_OUTOFMEMORY	Cannot allocate memory to create the new Strokes collection.
TPC_E_INVALID_STROKE	Stroke IDs that do not exist were passed to the method.

Remarks

If the ids parameter is NULL or an empty array, then an empty InkStrokes collection is created.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll