Método ITfContextComposition::StartComposition (msctf.h)

Crea una nueva composición.

Sintaxis

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

Parámetros

[in] ecWrite

Contiene una cookie de edición que identifica el contexto de edición. Esto se obtiene de ITfEditSession::D oEditSession.

[in] pCompositionRange

Puntero a un objeto ITfRange que especifica el texto que cubre inicialmente la composición.

[in] pSink

Puntero a un objeto ITfCompositionSink que recibe notificaciones de eventos de composición. Este parámetro es opcional y puede ser NULL. Si se proporciona, el objeto se libera cuando finaliza la composición.

[out] ppComposition

Puntero a un puntero de interfaz ITfComposition que recibe el nuevo objeto de composición. Este parámetro recibe NULL si el propietario del contexto rechaza la composición.

Valor devuelto

Este método puede devolver uno de estos valores.

Valor	Descripción
S_OK	Método realizado correctamente. Si la composición del propietario del contexto aconseja que el receptor rechace la composición, ppComposition se establece en NULL.
E_FAIL	Se ha producido un error no especificado.
E_INVALIDARG	Uno o varios parámetros no son válidos.
E_OUTOFMEMORY	No se puede crear el objeto de composición.
E_UNEXPECTED	Se llamó al método dentro de otra operación de composición.
TF_E_DISCONNECTED	El objeto de contexto no está en una pila de documentos.
TF_E_NOLOCK	El contexto de edición identificado por ecWrite no tiene un bloqueo de lectura y escritura.

Comentarios

Si el propietario del contexto ha instalado un receptor de asesoramiento de composición del propietario del contexto, se llama al método ITfContextOwnerCompositionSink::OnStartComposition . Si el receptor de aviso rechaza la nueva composición, este método devuelve S_OK pero ppComposition se establece en NULL.

Cualquier texto cubierto por pCompositionRange recibe la propiedad GUID_PROP_COMPOSING.

Requisitos

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

Interfaz IEnumITfCompositionView, interfaz ITfContextComposition, interfaz ITfRange, interfaz ITfCompositionSink, ITfContextOwnerCompositionSink::OnStartComposition, ITfEditSession::D oEditSession