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

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.

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.

Configuration requise

Voir aussi

ITfContextOwnerServices

ITfProperty

ITfRange

TF_PERSISTENT_PROPERTY_HEADER_ACP