IInkDisp::Clone method (msinkaut.h)

Article
02/22/2024

Creates a duplicate InkDisp object.

Syntax

HRESULT Clone(
  [out, retval] IInkDisp **NewInk
);

Parameters

[out, retval] NewInk

When this method returns, contains a pointer to the newly created InkDisp object.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_OUTOFMEMORY	Cannot allocate memory to complete the operation.
E_FAIL	An unspecified error occurred.
E_POINTER	A parameter contained an invalid pointer.
E_INK_EXCEPTION	An exception occurred inside the method.
REGDB_CLASSNOTREG	The InkDisp object was not registered.
E_UNEXPECTED	Unexpected parameter or property type.

Remarks

The Clone method is defined for the InkDisp, InkDrawingAttributes, and InkRecognizerContext objects. The Clone method returns an exact copy of the original object.

In most scenarios, the duplicate object is an exact copy of the original object, but no relation between the two objects exists. See the remarks section of this topic for details on exceptions to this.

InkDisp object: The only scenario in which the duplicate InkDisp object is not an exact copy of the original object is when a dirty InkDisp object is cloned. In this case, the duplicate InkDisp object's Dirty property is FALSE. All other properties of the cloned InkDisp object are exact copies.

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