ITfReadOnlyProperty::GetValue, méthode (msctf.h)

Article
08/24/2023

Obtient la valeur de la propriété pour une plage de texte.

Syntaxe

HRESULT GetValue(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pRange,
  [out] VARIANT      *pvarValue
);

Paramètres

[in] ec

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

[in] pRange

Pointeur vers une interface ITfRange qui spécifie la plage pour laquelle obtenir la propriété.

[out] pvarValue

Pointeur vers une valeur VARIANT qui reçoit la valeur de propriété. Le type de données et le contenu de cette valeur sont définis par le propriétaire de la propriété et doivent être reconnus par l’appelant pour pouvoir utiliser cette valeur. L’appelant doit libérer ces données, quand elles ne sont plus nécessaires, en passant cette valeur à l’API VariantClear .

Valeur retournée

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

Valeur	Description
S_OK	La méthode a réussi.
S_FALSE	La plage n’est pas couverte par la propriété ou la plage contient plusieurs valeurs de propriété. pvarValue reçoit une valeur VT_EMPTY.
E_INVALIDARG	Un ou plusieurs paramètres ne sont pas valides.
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 seule ou en lecture/écriture.

Notes

Si la propriété n’a pas de valeur sur pRange, pRange contient plusieurs valeurs pour la propriété ou si la propriété ne couvre pas complètement pRange, pvarValue reçoit une valeur VT_EMPTY et la méthode retourne S_FALSE.


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range--&gt;||&lt;-


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range--&gt;|    |&lt;-


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range--&gt;|             |&lt;-

Spécifications


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

ITfRange

ITfReadOnlyProperty

Partager via