Compartilhar via


Método ITfComposition::EndComposition (msctf.h)

Encerra uma composição.

Sintaxe

HRESULT EndComposition(
  [in] TfEditCookie ecWrite
);

Parâmetros

[in] ecWrite

Contém um cookie de edição que identifica o contexto de edição obtido de ITfEditSession::D oEditSession.

Valor retornado

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
O método foi bem-sucedido.
E_UNEXPECTED
Esse valor resulta quando:
  • A composição foi encerrada.
  • O chamador está dentro de outra operação de gravação de composição.
  • O chamador não possui a composição.
TF_E_NOLOCK
O contexto de edição identificado pelo ecWrite não tem um bloqueio de leitura/gravação.

Comentários

Esse método não libera o objeto de composição, mas os métodos ITfComposition falharão com E_UNEXPECTED depois que esse método for chamado.

Os proprietários de contexto devem usar o método ITFContextOwnerCompositionServices::TerminateComposition para encerrar uma composição.

Esse método faz com que a propriedade GUID_PROP_COMPOSING seja removida do texto coberto pela composição.

Requisitos

   
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

ITfContextOwnerCompositionServices::TerminateComposition, interface ITfComposition, ITfEditSession::D oEditSession