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

Article
08/24/2023

Crée une composition.

Syntaxe

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

Paramètres

[in] ecWrite

Contient un cookie de modification qui identifie le contexte de modification. Cette valeur est obtenue à partir de ITfEditSession::D oEditSession.

[in] pCompositionRange

Pointeur vers un objet ITfRange qui spécifie le texte que la composition couvre initialement.

[in] pSink

Pointeur vers un objet ITfCompositionSink qui reçoit des notifications d’événement de composition. Ce paramètre est facultatif et peut être NULL. S’il est fourni, l’objet est libéré lorsque la composition est terminée.

[out] ppComposition

Pointeur vers un pointeur d’interface ITfComposition qui reçoit le nouvel objet de composition. Ce paramètre reçoit la valeur NULL si le propriétaire du contexte rejette la composition.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Valeur	Description
S_OK	La méthode a réussi. Si le récepteur de conseil de composition du propriétaire du contexte rejette la composition, ppComposition a la valeur NULL.
E_FAIL	Une erreur non spécifiée s'est produite.
E_INVALIDARG	Un ou plusieurs paramètres ne sont pas valides.
E_OUTOFMEMORY	Impossible de créer l’objet de composition.
E_UNEXPECTED	La méthode a été appelée dans une autre opération de composition.
TF_E_DISCONNECTED	L’objet de contexte ne se trouve pas sur une pile de documents.
TF_E_NOLOCK	Le contexte de modification identifié par ecWrite n’a pas de verrou en lecture/écriture.

Notes

Si le propriétaire du contexte a installé un récepteur d’avis de composition de propriétaire de contexte, la méthode ITfContextOwnerCompositionSink::OnStartComposition est appelée. Si le récepteur d’avis rejette la nouvelle composition, cette méthode retourne S_OK, mais ppComposition a la valeur NULL.

Tout texte couvert par pCompositionRange reçoit la propriété GUID_PROP_COMPOSING.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	msctf.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel

Voir aussi

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