IInkDisp::ClipboardCopy
4/8/2010
Copies an IInkDisp object's IInkStrokes collection 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 strokes parameter is Null, the ClipboardCopy method copies the entire IInkDisp object. The default value is a NULL pointer.
- formats
[in, optional] Specifies the InkClipboardFormats enumeration value of the IInkDisp object. The default value is ICF_Default.
- modes
[in, optional] Specifies the InkClipboardModes enumeration value of the IInkDisp object. 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 strokes parameter to NULL copies the IInkDisp object to the Clipboard, including the IInkDisp::CustomStrokes property, and recognition results for strokes in the IInkDisp object's IInkCustomStrokes collection are maintained.
If an empty IInkStrokes collection 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 |