Метод ITfContextComposition::StartComposition (msctf.h)

Статья
08/24/2023

Создает новую композицию.

Синтаксис

HRESULT StartComposition(
  [in]  TfEditCookie       ecWrite,
  [in]  ITfRange           *pCompositionRange,
  [in]  ITfCompositionSink *pSink,
  [out] ITfComposition     **ppComposition
);

Параметры

[in] ecWrite

Содержит файл cookie редактирования, определяющий контекст редактирования. Он получен из ITfEditSession::D oEditSession.

[in] pCompositionRange

Указатель на объект ITfRange , указывающий текст, который изначально охватывает композиция.

[in] pSink

Указатель на объект ITfCompositionSink , который получает уведомления о событиях композиции. Этот параметр является необязательным и может иметь значение NULL. Если он указан, объект освобождается после завершения композиции.

[out] ppComposition

Указатель на указатель интерфейса ITfComposition , который получает новый объект композиции. Этот параметр получает значение NULL , если владелец контекста отклоняет композицию.

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

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

Значение	Описание
S_OK	Метод выполнен успешно. Если композиция владельца контекста рекомендует приемнику отклонять композицию, ppComposition имеет значение NULL.
E_FAIL	Произошла неизвестная ошибка.
E_INVALIDARG	Один или несколько параметров являются недопустимыми.
E_OUTOFMEMORY	Невозможно создать объект композиции.
E_UNEXPECTED	Метод был вызван в другой операции композиции.
TF_E_DISCONNECTED	Объект контекста не находится в стеке документов.
TF_E_NOLOCK	Контекст редактирования, определяемый ecWrite , не имеет блокировки чтения и записи.

Если владелец контекста установил приемник рекомендаций по композиции владельца контекста, вызывается метод ITfContextOwnerCompositionSink::OnStartComposition . Если приемник рекомендаций отклоняет новую композицию, этот метод возвращает S_OK но ppComposition имеет значение NULL.

Любой текст, охватываемый pCompositionRange , получает свойство GUID_PROP_COMPOSING.

Требования


Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	msctf.h
DLL	Msctf.dll
Распространяемые компоненты	TSF 1.0 в Windows 2000 Профессиональная

См. также раздел

Интерфейс IEnumITfCompositionView, интерфейс ITfContextComposition, интерфейс ITfRange, интерфейс ITfCompositionSink, ITfContextOwnerCompositionSink::OnStartComposition, ITfEditSession::D oEditSession

Поделиться через