IInkDisp::ClipboardCopy メソッド (msinkaut.h)

  • [アーティクル]

InkStrokes コレクションをクリップボードにコピーします。

構文

HRESULT ClipboardCopy(
  [in, optional] IInkStrokes         *strokes,
  [in, optional] InkClipboardFormats ClipboardFormats,
  [in, optional] InkClipboardModes   ClipboardModes,
  [out, retval]  IDataObject         **DataObject
);

パラメーター

[in, optional] strokes

任意。 コピーするストロークを指定します。 strokes パラメーターが NULL の場合、 ClipboardCopy メソッドは InkDisp オブジェクト全体をコピーします。 既定値は NULL です。

[in, optional] ClipboardFormats

省略可能。 InkDisp オブジェクトの InkClipboardFormats 列挙値を指定します。 既定値は ICF_Default です。

[in, optional] ClipboardModes

省略可能。 InkDisp オブジェクトの InkClipboardModes 列挙値を指定します。 既定値は ICB_Default です。

[out, retval] DataObject

このメソッドが戻るとき、 には、新しく作成されたデータ オブジェクトへのポインターが含まれます。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード 説明
S_OK
 正常終了しました。
E_POINTER
 パラメーターに無効なポインターが含まれていました。
E_INK_EXCEPTION
 メソッド内で例外が発生しました。
E_INK_MISMATCHED_INK_OBJECT
 strokes パラメーターは、別の Ink オブジェクトに関連付けられています。

解説

このメソッドは、認識結果を含め、ストロークのすべてのプロパティをコピーします。 strokes パラメーターを NULL に設定すると、CustomStrokes プロパティを含む InkDisp オブジェクトがクリップボードにコピーされ、InkDisp オブジェクトの IInkCustomStrokes コレクション内のストロークの認識結果が保持されます。

空の InkStrokes コレクションが渡された場合、メソッドは NULL を 返し、クリップボードの内容は変更されません。

メモ クリップボード API を機能させるには、OleInitialize(NULL) を呼び出す必要があります。
 
注意ICB_DelayedCopy フラグを使用した結果としてメモリ リークが発生する可能性を回避するには、OleFlushClipboard メソッドまたは OleSetClipboard メソッドを呼び出す必要があります。 これは、ClipboardCopy メソッドの最後の呼び出しで ICB_DelayedCopy フラグが使用された場合に、アプリケーションが終了する前に行う必要があります。
 

要件

   
サポートされている最小のクライアント Windows XP Tablet PC Edition [デスクトップ アプリのみ]
サポートされている最小のサーバー サポートなし
対象プラットフォーム Windows
ヘッダー msinkaut.h
Library InkObj.dll

関連項目

ClipboardCopyWithRectangle メソッド

IInkDisp

InkClipboardFormats 列挙

InkClipboardModes 列挙

InkDisp クラス

InkStrokes コレクション