Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
4/8/2010

Copies an IInkDispobject's IInkStrokescollection to the Clipboard.

Syntax 

HRESULT ClipboardCopy (
  [in, optional, defaultvalue(NULL)] IInkStrokes* strokes,
  [in, optional, defaultvalue(ICF_Default)] InkClipboardFormats
formats,
  [in, optional, defaultvalue(ICB_Default)] InkClipboardModes
modes,
  [out, retval] IDataObject** DataObject,
);

Parameters

strokes

[in, optional] Specifies the strokes to copy. If the strokesparameter is Null, the ClipboardCopymethod copies the entire IInkDispobject. The default value is a NULL pointer.

formats

[in, optional] Specifies the InkClipboardFormatsenumeration value of the IInkDispobject. The default value is ICF_Default.

modes

[in, optional] Specifies the InkClipboardModesenumeration value of the IInkDispobject. The default value is ICB_Default.

DataObject

[out, retval] Returns the newly created data object.

Return Value

S_OK

Success.

E_POINTER

A parameter contained an invalid pointer.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INK_MISMATCHED_INK_OBJECT

The strokes parameter is associated with a different Ink object.

Remarks

This method copies all properties of the stroke, including recognition results. Setting the strokesparameter to NULL copies the IInkDispobject to the Clipboard, including the IInkDisp::CustomStrokesproperty, and recognition results for strokes in the IInkDispobject's IInkCustomStrokescollection are maintained.

If an empty IInkStrokescollection is passed, the method returns NULL and the contents of the Clipboard are not modified.

Requirements

Header msinkaut.h
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later

See Also