ITfContextOwnerServices::Serialize-Methode (msctf.h)

Artikel
08/24/2023

Die ITfContextOwnerServices::Serialize-Methode ruft eine Eigenschaft aus einem Textbereich ab und schreibt die Eigenschaftsdaten in ein Streamobjekt. Dadurch kann eine Anwendung Eigenschaftendaten speichern, z. B. beim Schreiben der Daten in eine Datei.

Syntax

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

Parameter

[in] pProp

Zeiger auf eine ITfProperty-Schnittstelle , die die zu serialisierende Eigenschaft identifiziert.

[in] pRange

Zeiger auf eine ITfRange-Schnittstelle , die den Bereich identifiziert, aus dem die Eigenschaft abgerufen wird.

[out] pHdr

Zeiger auf eine TF_PERSISTENT_PROPERTY_HEADER_ACP-Struktur , die die Headerdaten für die -Eigenschaft empfängt.

[in] pStream

Zeiger auf ein IStream-Objekt , in das der TSF-Manager die Eigenschaftendaten schreibt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
S_FALSE	Die Eigenschaft kann nicht serialisiert werden.
E_FAIL	Es ist ein unbekannter Fehler aufgetreten.

Hinweise

Die in pHdr platzierten Eigenschaftenheaderdaten sind allen Eigenschaften gemeinsam und müssen mit den in pStream geschriebenen Daten beibehalten werden. Dasselbe Datenpaar muss an ITfContextOwnerServices::Unserialize übergeben werden, um die Eigenschaftendaten wiederherzustellen.

Eine Anwendung kann alle Eigenschaften für das gesamte Dokument speichern, indem sie die folgenden Schritte ausführt.

Auflisten aller Eigenschaften mithilfe von ITfContext::EnumProperties.
Enumerieren Sie innerhalb jeder Eigenschaft die Bereiche mithilfe von ITfReadOnlyProperty::EnumRanges.
Übergeben Sie die aktuelle Eigenschaft und den aktuellen Bereich an diese Methode.
Schreiben Sie die in pHdr platzierten Daten in die Datei.
Schreiben Sie die zu pStream hinzugefügten Daten in die Datei.

Beim Aufrufen dieser Methode muss die Anwendung in der Lage sein, eine synchrone schreibgeschützte Sperre zu gewähren.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	msctf.h
DLL	Msctf.dll
Verteilbare Komponente	TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITfContextOwnerServices

ITfProperty

ITfRange

TF_PERSISTENT_PROPERTY_HEADER_ACP

Freigeben über