Метод IInkDisp::ClipboardCopy (msinkaut.h)

Статья
08/24/2023

Копирует коллекцию 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

Необязательный элемент. Задает значение перечисления InkClipboardFormats объекта InkDisp . Значение по умолчанию — ICF_Default.

[in, optional] ClipboardModes

Необязательный элемент. Задает значение перечисления InkClipboardModes объекта InkDisp . Значение по умолчанию — ICB_Default.

[out, retval] DataObject

При возврате этим методом содержит указатель на вновь созданный объект данных.

Возвращаемое значение

Этот метод может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Успешно.
E_POINTER	Параметр содержит недопустимый указатель.
E_INK_EXCEPTION	В методе произошло исключение.
E_INK_MISMATCHED_INK_OBJECT	Параметр strokes связан с другим объектом Ink.

Этот метод копирует все свойства росчерка, включая результаты распознавания. Если задать для параметра strokesзначение NULL, объект InkDisp копируется в буфер обмена, включая свойство CustomStrokes, и сохраняются результаты распознавания штрихов в коллекции IInkCustomStrokes объекта InkDisp.

Если передается пустая коллекция InkStrokes , метод возвращает значение NULL , а содержимое буфера обмена не изменяется.

Примечание. Прежде чем API буфера обмена смогут работать, необходимо вызвать OleInitialize(NULL).

Осторожностью Чтобы избежать потенциальных утечек памяти в результате использования флага ICB_DelayedCopy , необходимо вызвать метод OleFlushClipboard или OleSetClipboard . Это необходимо сделать до завершения работы приложения, если в последнем вызове метода ClipboardCopy использовался флаг ICB_DelayedCopy .

Требования


Минимальная версия клиента	Windows XP Tablet PC Edition [только классические приложения]
Минимальная версия сервера	Ни одна версия не поддерживается
Целевая платформа	Windows
Header	msinkaut.h
Библиотека	InkObj.dll