IInkStrokes::Add method (msinkaut.h)

Article
02/22/2024

Adds an IInkStrokeDisp object or InkStrokes collection to an existing InkStrokes collection.

Syntax

HRESULT Add(
  [in] IInkStrokeDisp *InkStroke
);

Parameters

[in] InkStroke

The stroke to add to the 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_OUTOFMEMORY	Cannot allocate Stroke handler helper object.
E_INK_EXCEPTION	An exception occurred inside the method.
E_INK_INCOMPATIBLE_OBJECT	IInkStrokeDisp* does not point to a compatible IInkStrokeDisp object.
E_INK_MISMATCHED_INK_OBJECT	The InkDisp object of the IInkStrokeDisp being added does not match the InkDisp object of the InkStrokes collection.

Remarks

Note The stroke must already exist within the InkDisp object, and cannot belong to another InkDisp object. Also, this method does not copy or otherwise alter the InkDisp object, but merely adds this stroke to the collection.

Use this method to add one stroke to an InkStrokes collection. To add one collection of strokes to another, use the AddStrokes method.

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