Méthode ITfContextOwnerServices ::Serialize (msctf.h)

Article
03/04/2024

La méthode ITfContextOwnerServices ::Serialize obtient une propriété à partir d’une plage de texte et écrit les données de propriété dans un objet stream. Cela permet à une application de stocker des données de propriété, par exemple, lors de l’écriture des données dans un fichier.

Syntaxe

HRESULT Serialize(
  [in]  ITfProperty                       *pProp,
  [in]  ITfRange                          *pRange,
  [out] TF_PERSISTENT_PROPERTY_HEADER_ACP *pHdr,
  [in]  IStream                           *pStream
);

Paramètres

[in] pProp

Pointeur vers une interface ITfProperty qui identifie la propriété à sérialiser.

[in] pRange

Pointeur vers une interface ITfRange qui identifie la plage à partir de laquelle la propriété est obtenue.

[out] pHdr

Pointeur vers une structure TF_PERSISTENT_PROPERTY_HEADER_ACP qui reçoit les données d’en-tête de la propriété .

[in] pStream

Pointeur vers un objet IStream dans lequel le gestionnaire TSF écrit les données de propriété.

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 propriété ne peut pas être sérialisée.
E_FAIL	Une erreur non spécifiée s'est produite.

Remarques

Les données d’en-tête de propriété placées en pHdr sont communes à toutes les propriétés et doivent être conservées avec les données écrites dans pStream. Cette même paire de données doit être passée à ITfContextOwnerServices ::Unserialize pour restaurer les données de propriété.

Une application peut enregistrer toutes les propriétés de l’ensemble du document en effectuant les étapes suivantes.

Énumérez toutes les propriétés à l’aide de ITfContext ::EnumProperties.
Dans chaque propriété, énumérez les plages à l’aide de ITfReadOnlyProperty ::EnumRanges.
Passez la propriété et la plage actuelles à cette méthode.
Écrivez les données placées en pHdr dans le fichier.
Écrivez les données ajoutées à pStream dans le fichier.

Lors de l’appel de cette méthode, l’application doit être en mesure d’accorder un verrou synchrone en lecture seule.

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

ITfContextOwnerServices

ITfProperty

ITfRange

TF_PERSISTENT_PROPERTY_HEADER_ACP

Partager via