Метод ITfContextOwnerCompositionServices::TerminateComposition (msctf.h)

Завершает композицию.

Синтаксис

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

Параметры

[in] pComposition

Указатель на интерфейс ITfCompositionView , представляющий завершаемую композицию. Если это значение равно NULL, все композиции в контексте завершаются.

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

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

Значение Описание
S_OK
Метод выполнен успешно.
TF_E_DISCONNECTED
Контекст не находится в стеке документов.
TF_E_NOLOCK
Служба текста в настоящее время удерживает блокировку на документе.
E_UNEXPECTED
Этот метод был вызван во время другой операции композиции.
E_FAIL
Произошла неизвестная ошибка.

Комментарии

Служба текста использует ITfComposition::EndComposition для завершения созданной композиции.

Если владелец контекста реализует текстовое хранилище, владелец контекста должен иметь возможность предоставить синхронную блокировку записи перед вызовом этого метода.

Этот метод также выполняет следующие действия:

  • Для каждой завершенной композиции вызывается ITfCompositionSink::OnCompositionTerminated для всех установленных приемников рекомендаций композиции.
  • Если владелец контекста установил приемник рекомендаций по композиции владельца контекста, для каждой завершаемой композиции вызывается ITfContextOwnerCompositionSink::OnEndComposition .
  • Свойство GUID_PROP_COMPOSING будет очищено для текста, охватываемого каждой завершаемой композицией.

Требования

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

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

ITfComposition::EndComposition, nf-msctf-itfcompositionsink-oncompositionterminated, интерфейс ITfCompositionView, интерфейс ITfContextOwnerCompositionServices, ITfContextOwnerCompositionSink::OnEndComposition