Metodo ITfContextComposition::StartComposition (msctf.h)

  • Articolo

Crea una nuova composizione.

Sintassi

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

Parametri

[in] ecWrite

Contiene un cookie di modifica che identifica il contesto di modifica. Si ottiene da ITfEditSession::D oEditSession.

[in] pCompositionRange

Puntatore a un oggetto ITfRange che specifica il testo che la composizione copre inizialmente.

[in] pSink

Puntatore a un oggetto ITfCompositionSink che riceve le notifiche degli eventi di composizione. Questo parametro è facoltativo e può essere NULL. Se specificato, l'oggetto viene rilasciato quando la composizione viene terminata.

[out] ppComposition

Puntatore a un puntatore all'interfaccia ITfComposition che riceve il nuovo oggetto composizione. Questo parametro riceve NULL se il proprietario del contesto rifiuta la composizione.

Valore restituito

Questo metodo può restituire uno di questi valori.

Valore Descrizione
S_OK
 Il metodo è stato eseguito correttamente. Se la composizione del proprietario del contesto consiglia al sink di rifiutare la composizione, ppComposition è impostato su NULL.
E_FAIL
 Si è verificato un errore non specificato.
E_INVALIDARG
 Uno o più parametri non sono validi.
E_OUTOFMEMORY
 Impossibile creare l'oggetto composizione.
E_UNEXPECTED
 Il metodo è stato chiamato all'interno di un'altra operazione di composizione.
TF_E_DISCONNECTED
 L'oggetto di contesto non si trova in uno stack di documenti.
TF_E_NOLOCK
 Il contesto di modifica identificato da ecWrite non dispone di un blocco di lettura/scrittura.

Commenti

Se il proprietario del contesto ha installato un sink di composizione del proprietario del contesto, viene chiamato il metodo ITfContextOwnerCompositionSink::OnStartComposition . Se il sink di avviso rifiuta la nuova composizione, questo metodo restituisce S_OK ma ppComposition è impostato su NULL.

Qualsiasi testo coperto da pCompositionRange riceve la proprietà GUID_PROP_COMPOSING.

Requisiti

   
Client minimo supportato Windows 2000 Professional [app desktop | App UWP]
Server minimo supportato Windows 2000 Server [app desktop | App UWP]
Piattaforma di destinazione Windows
Intestazione msctf.h
DLL Msctf.dll
Componente ridistribuibile TSF 1.0 in Windows 2000 Professional

Vedi anche

Interfaccia IEnumITfCompositionView, interfaccia ITfContextComposition, interfaccia ITfRange, interfaccia ITfCompositionSink, interfaccia ITfContextOwnerCompositionSink::OnStartComposition, ITfEditSession::D oEditSession