IInkDisp::ClipboardPaste method (msinkaut.h)

Copies the IDataObject from the Clipboard to the InkDisp object.

Syntax

HRESULT ClipboardPaste(
  [in, optional] long        x,
  [in, optional] long        y,
  [in, optional] IDataObject *DataObject,
  [out, retval]  IInkStrokes **Strokes
);

Parameters

[in, optional] x

Optional. Specifies the x-coordinate to paste to in ink space coordinates. The default value is 0.

[in, optional] y

Optional. Specifies the y-coordinate to paste to in ink space coordinates. The default value is 0.

[in, optional] DataObject

Optional. Specifies the IDataObject to be used. To paste from the Clipboard, set to NULL. The default value is NULL.

[out, retval] Strokes

When this method returns, contains a pointer to the InkStrokes collection in the InkDisp object.

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_INK_EXCEPTION	An exception occurred inside the method.

Remarks

An error is returned if an unexpected error occurs while accessing the Clipboard. If no error occurs but the Clipboard does not contain a format that can be pasted into ink -either ink serialized format (ISF) or a text ink object (tInk) -then NULL is returned and no exception is thrown.

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

See also

IInkDisp

InkDisp Class

InkStrokes Collection