InkDisp.ExtractStrokes method

Specifies the strokes to extract from an InkDisp Class and cut or copy into a new InkDisp Class, by using the known collection of strokes to determine which strokes to extract.

Syntax


HRESULT ExtractStrokes(
  [in, optional] IInkStrokes     *Strokes,
  [in, optional] InkExtractFlags ExtractFlags,
  [out, retval]  IInkDisp        **ExtractedInk
);

Parameters

Strokes [in, optional]

Optional. Specifies the collection of strokes to extract. The default value is 0, which specifies that all strokes are extracted.

ExtractFlags [in, optional]

Optional. Specifies the InkExtractFlags Enumeration type, which specifies whether the ink is cut or copied into the new Ink object. The default value is IEF_DEFAULT, which cuts the strokes.

ExtractedInk [out, retval]

When this method returns, contains a pointer to a new InkDisp Class object that contains the extracted collection of cut or copied strokes.

Return value

This method can return one of these values.

Return codeDescription
S_OK

Success

E_POINTER

A parameter contained an invalid pointer.

E_INK_MISMATCHED_INK_OBJECT

The InkDisp Class object of the InkStrokes Collection collection must match the known InkDisp Class.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INK_SOME_STROKES_NOT_EXTRACTED

Not all strokes were extracted.

E_OUTOFMEMORY

Cannot allocate memory that is used to perform the operation.

E_INVALIDARG

Invalid extraction flags.

REGDB_CLASSNOTREG

The InkDisp Class object class is not registered.

 

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkDisp Class
ExtractWithRectangle Method

 

 

Show: