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

Finaliza una composición.

Sintaxis

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

Parámetros

[in] pComposition

Puntero a una interfaz ITfCompositionView que representa la composición que se va a finalizar. Si este valor es NULL, todas las composiciones del contexto finalizan.

Valor devuelto

Este método puede devolver uno de estos valores.

Valor	Descripción
S_OK	Método realizado correctamente.
TF_E_DISCONNECTED	El contexto no está en una pila de documentos.
TF_E_NOLOCK	Actualmente, un servicio de texto contiene un bloqueo en el documento.
E_UNEXPECTED	Se llamó a este método durante otra operación de composición.
E_FAIL	Se ha producido un error no especificado.

Comentarios

Un servicio de texto usa ITfComposition::EndComposition para finalizar una composición que creó.

Si el propietario del contexto implementa el almacén de texto, el propietario del contexto debe poder conceder un bloqueo de escritura sincrónico antes de llamar a este método.

Este método también hace lo siguiente:

• Para cada composición terminada, se llama a ITfCompositionSink::OnCompositionTerminated para todos los receptores de asesoramiento de composición instalados.
• Si el propietario del contexto instaló un receptor de asesoramiento de composición del propietario del contexto, se llama a ITfContextOwnerCompositionSink::OnEndComposition para cada composición terminada.
• La propiedad GUID_PROP_COMPOSING se borrará para el texto cubierto por cada composición terminada.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows 2000 Server [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	msctf.h
Archivo DLL	Msctf.dll
Redistribuible	TSF 1.0 en Windows 2000 Professional

Consulte también

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