Méthode ITfProperty ::SetValue (msctf.h)

Article
02/29/2024

Définit la valeur de la propriété pour une plage.

Syntaxe

HRESULT SetValue(
  [in] TfEditCookie  ec,
  [in] ITfRange      *pRange,
  [in] const VARIANT *pvarValue
);

Paramètres

[in] ec

Contient un cookie de modification qui identifie le contexte de modification. Elle est obtenue à partir de ITfDocumentMgr ::CreateContext ou ITfEditSession ::D oEditSession.

[in] pRange

Pointeur vers une interface ITfRange qui contient la plage pour laquelle la valeur de propriété est définie. Ce paramètre ne peut pas avoir la valeur NULL. Cette méthode échoue si pRange est vide.

[in] pvarValue

Pointeur vers une structure VARIANT qui contient la nouvelle valeur de propriété. Seules les valeurs de type VT_I4, VT_UNKNOWN, VT_BSTR et VT_EMPTY sont prises en charge.

Valeur retournée

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

Valeur	Description
S_OK	La méthode a réussi.
E_INVALIDARG	Un ou plusieurs paramètres ne sont pas valides.
E_OUTOFMEMORY	Un échec d’allocation de mémoire s’est produit.
E_FAIL	Une erreur non spécifiée s'est produite.
TF_E_NOLOCK	Le contexte de modification identifié par ec n’a pas de verrou en lecture/écriture.
TF_E_READONLY	Le contexte de modification est en lecture seule.
TF_E_NOTOWNEDRANGE	Le gestionnaire TSF n’est pas propriétaire de la plage.

Remarques

Les valeurs de propriété définies avec cette méthode sont ignorées lorsque le texte couvert par la valeur de la propriété est modifié. Pour obtenir un contrôle personnalisé sur une réponse de valeur aux modifications de texte, utilisez ITfProperty ::SetValueStore.

Les valeurs définies avec cette méthode sont sérialisées, à l’exception des valeurs de type VT_UNKNOWN, qui ne sont pas sérialisées. Si une valeur de propriété de type VT_UNKNOWN doit être sérialisée, utilisez plutôt ITfProperty ::SetValueStore .

Les valeurs de propriété qui se chevauchent du même type ne sont pas prises en charge.

Configuration requise

Condition requise	Valeur
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

ITfDocumentMgr ::CreateContext

ITfEditSession ::D oEditSession

ITfProperty

ITfProperty ::SetValueStore

ITfRange

Partager via