Метод ITfContextOwnerServices::Serialize (msctf.h)

Метод ITfContextOwnerServices::Serialize получает свойство из диапазона текста и записывает данные свойства в объект потока. Это позволяет приложению хранить данные свойств, например при записи данных в файл.

Синтаксис

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

Параметры

[in] pProp

Указатель на интерфейс ITfProperty , который определяет свойство для сериализации.

[in] pRange

Указатель на интерфейс ITfRange , который определяет диапазон, из котором получено свойство.

[out] pHdr

Указатель на структуру TF_PERSISTENT_PROPERTY_HEADER_ACP , которая получает данные заголовка для свойства .

[in] pStream

Указатель на объект IStream , в который диспетчер TSF будет записывать данные свойства.

Возвращаемое значение

Этот метод может возвращать одно из этих значений.

Значение Описание
S_OK
Метод выполнен успешно.
S_FALSE
Невозможно сериализовать свойство .
E_FAIL
Произошла неизвестная ошибка.

Комментарии

Данные заголовка свойства, помещенные в pHDR , являются общими для всех свойств и должны сохраняться вместе с данными, записанными в pStream. Эту же пару данных необходимо передать в ITfContextOwnerServices::Unserialize для восстановления данных свойства.

Приложение может сохранить все свойства для всего документа, выполнив следующие действия.

  • Перечисление всех свойств с помощью ITfContext::EnumProperties.
  • В каждом свойстве перечислите диапазоны с помощью ITfReadOnlyProperty::EnumRanges.
  • Передайте текущее свойство и диапазон в этот метод.
  • Запишите данные, помещенные в pHDR , в файл.
  • Запишите данные, добавленные в pStream , в файл.
При вызове этого метода приложение должно иметь возможность предоставить синхронную блокировку только для чтения.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Профессиональная [классические приложения | Приложения UWP]
Минимальная версия сервера Windows 2000 Server [классические приложения | Приложения UWP]
Целевая платформа Windows
Header msctf.h
DLL Msctf.dll
Распространяемые компоненты TSF 1.0 в Windows 2000 Профессиональная

См. также раздел

ITfContextOwnerServices

ITfProperty

ITfRange

TF_PERSISTENT_PROPERTY_HEADER_ACP