Compartilhar via


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

O método ITfContextOwnerServices::Serialize obtém uma propriedade de um intervalo de texto e grava os dados da propriedade em um objeto de fluxo. Isso permite que um aplicativo armazene dados de propriedade, por exemplo, ao gravar os dados em um arquivo.

Sintaxe

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

Parâmetros

[in] pProp

Ponteiro para uma interface ITfProperty que identifica a propriedade a ser serializada.

[in] pRange

Ponteiro para uma interface ITfRange que identifica o intervalo do qual a propriedade é obtida.

[out] pHdr

Ponteiro para uma estrutura TF_PERSISTENT_PROPERTY_HEADER_ACP que recebe os dados de cabeçalho da propriedade.

[in] pStream

Ponteiro para um objeto IStream no qual o gerenciador do TSF gravará os dados da propriedade.

Retornar valor

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
O método foi bem-sucedido.
S_FALSE
A propriedade não pode ser serializada.
E_FAIL
Ocorreu um erro não especificado.

Comentários

Os dados de cabeçalho de propriedade colocados em pHdr são comuns a todas as propriedades e devem ser preservados com os dados gravados em pStream. Esse mesmo par de dados deve ser passado para ITfContextOwnerServices::Unserialize para restaurar os dados da propriedade.

Um aplicativo pode salvar todas as propriedades de todo o documento executando as etapas a seguir.

  • Enumerar todas as propriedades usando ITfContext::EnumProperties.
  • Dentro de cada propriedade, enumere os intervalos usando ITfReadOnlyProperty::EnumRanges.
  • Passe a propriedade e o intervalo atuais para esse método.
  • Escreva os dados colocados em pHdr no arquivo.
  • Escreva os dados adicionados ao pStream no arquivo.
Ao chamar esse método, o aplicativo deve ser capaz de conceder um bloqueio somente leitura síncrona.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho msctf.h
DLL Msctf.dll
Redistribuível TSF 1.0 no Windows 2000 Professional

Confira também

ITfContextOwnerServices

ITfProperty

ITfRange

TF_PERSISTENT_PROPERTY_HEADER_ACP