Compartilhar via

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

  • Artigo

Cria uma nova composição.

Sintaxe

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

Parâmetros

[in] ecWrite

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

[in] pCompositionRange

Ponteiro para um objeto ITfRange que especifica o texto que a composição aborda inicialmente.

[in] pSink

Ponteiro para um objeto ITfCompositionSink que recebe notificações de evento de composição. Esse parâmetro é opcional e pode ser NULL. Se fornecido, o objeto será liberado quando a composição for encerrada.

[out] ppComposition

Ponteiro para um ponteiro de interface ITfComposition que recebe o novo objeto de composição. Esse parâmetro receberá NULL se o proprietário do contexto rejeitar a composição.

Valor retornado

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
 O método foi bem-sucedido. Se a composição do proprietário do contexto aconselhar que o coletor rejeite a composição, ppComposition será definido como NULL.
E_FAIL
 Ocorreu um erro não especificado.
E_INVALIDARG
 Um ou mais parâmetros são inválidos.
E_OUTOFMEMORY
 O objeto de composição não pode ser criado.
E_UNEXPECTED
 O método foi chamado em outra operação de composição.
TF_E_DISCONNECTED
 O objeto de contexto não está em uma pilha de documentos.
TF_E_NOLOCK
 O contexto de edição identificado pelo ecWrite não tem um bloqueio de leitura/gravação.

Comentários

Se o proprietário do contexto tiver instalado um coletor de aconselhamento de composição de proprietário de contexto, o método ITfContextOwnerCompositionSink::OnStartComposition será chamado. Se o coletor de aviso rejeitar a nova composição, esse método retornará S_OK mas ppComposition será definido como NULL.

Qualquer texto coberto por pCompositionRange recebe a propriedade GUID_PROP_COMPOSING.

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

Interface IEnumITfCompositionView, interface ITfContextComposition, interface ITfRange, interface ITfCompositionSink, ITfContextOwnerCompositionSink::OnStartComposition, ITfEditSession::D oEditSession