Função WriteFmtUserTypeStg (ole2.h)

A função WriteFmtUserTypeStg grava um formato de área de transferência e um tipo de usuário no objeto de armazenamento.

Sintaxe

HRESULT WriteFmtUserTypeStg(
  [in] LPSTORAGE  pstg,
  [in] CLIPFORMAT cf,
  [in] LPOLESTR   lpszUserType
);

Parâmetros

[in] pstg

Ponteiro IStorage para o objeto de armazenamento em que as informações devem ser gravadas.

[in] cf

Especifica o formato da área de transferência que descreve a estrutura da área nativa do objeto de armazenamento. A marca de formato inclui a política para os nomes de fluxos e substorages dentro desse objeto de armazenamento e as regras para interpretar dados dentro desses fluxos.

[in] lpszUserType

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo que especifica o tipo de usuário atual do objeto. O valor do tipo de usuário, em si, não pode ser NULL. Esse é o tipo retornado pelo método IOleObject::GetUserType . Se essa função for transportada para um computador remoto em que a classe de objeto não existe, esse tipo de usuário armazenado persistentemente poderá ser mostrado ao usuário em caixas de diálogo.

Retornar valor

Essa função retorna HRESULT.

Comentários

A função WriteFmtUserTypeStg deve ser chamada na implementação de um objeto do método IPersistStorage::Save . Ele também deve ser chamado por objetos de nível de documento que usam o armazenamento estruturado para sua representação persistente em sua sequência de salvamento.

Para ler as informações salvas, os aplicativos chamam a função ReadFmtUserTypeStg .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ole2.h
Biblioteca	Ole32.lib
DLL	Ole32.dll
Conjunto de APIs	ext-ms-win-com-ole32-l1-1-3 (introduzido no Windows 10, versão 10.0.10240)

Confira também

IPersistStorage::Save

ReadFmtUserTypeStg