Compartilhar via

Método ITfContextOwnerCompositionServices::TerminateComposition (msctf.h)

  • Artigo

Encerra uma composição.

Sintaxe

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

Parâmetros

[in] pComposition

Ponteiro para uma interface ITfCompositionView que representa a composição a ser encerrada. Se esse valor for NULL, todas as composições no contexto serão encerradas.

Retornar valor

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
 O método foi bem-sucedido.
TF_E_DISCONNECTED
 O contexto não está em uma pilha de documentos.
TF_E_NOLOCK
 Um serviço de texto atualmente mantém um bloqueio no documento.
E_UNEXPECTED
 Esse método foi chamado durante outra operação de composição.
E_FAIL
 Ocorreu um erro não especificado.

Comentários

Um serviço de texto usa ITfComposition::EndComposition para encerrar uma composição que ele criou.

Se o proprietário do contexto implementar o repositório de texto, o proprietário do contexto deverá ser capaz de conceder um bloqueio de gravação síncrono antes de chamar esse método.

Esse método também faz o seguinte:

  • Para cada composição encerrada, ITfCompositionSink::OnCompositionTerminated é chamado para todos os coletores de consultoria de composição instalados.
  • Se o proprietário do contexto tiver instalado um coletor de aviso de composição de proprietário de contexto, ITfContextOwnerCompositionSink::OnEndComposition será chamado para cada composição terminada.
  • A propriedade GUID_PROP_COMPOSING será limpa para o texto coberto por cada composição terminada.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho msctf.h
DLL Msctf.dll
Redistribuível TSF 1.0 no Windows 2000 Professional

Confira também

ITfComposition::EndComposition, nf-msctf-itfcompositionsink-oncompositionterminated, interface ITfCompositionView, interface ITfContextOwnerCompositionServices, ITfContextOwnerCompositionSink::OnEndComposition