Método IOleCache::SetData (oleidl.h)

  • Artigo

Inicializa o cache com dados em um formato especificado e em um meio especificado.

Sintaxe

HRESULT SetData(
  [in] FORMATETC *pformatetc,
  [in] STGMEDIUM *pmedium,
  [in] BOOL      fRelease
);

Parâmetros

[in] pformatetc

Um ponteiro para uma estrutura FORMATETC que especifica o formato dos dados de apresentação que estão sendo colocados no cache.

[in] pmedium

Um ponteiro para uma estrutura STGMEDIUM que especifica o meio de armazenamento que contém os dados da apresentação.

[in] fRelease

Indica a propriedade do meio de armazenamento após a conclusão do método. Se fRelease for TRUE, o cache assumirá a propriedade, liberando o meio quando terminar de usá-lo. Quando fRelease é FALSE, o chamador retém a propriedade e é responsável por liberar o meio. O cache só pode usar o meio de armazenamento durante a chamada.

Retornar valor

Esse método retorna S_OK em caso de êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno Descrição
DV_E_LINDEX
 O valor não é válido para pformatetc-lindex>. Atualmente, há suporte apenas para -1.
DV_E_FORMATETC
 A estrutura FORMATETC é inválida.
DV_E_TYMED
 O valor não é válido para pformatetc-tymed>.
DV_E_DVASPECT
 O valor não é válido para pformatetc-dwAspect>.
OLE_E_BLANK
 Há um objeto não inicializado.
DV_E_TARGETDEVICE
 O objeto é estático e pformatetc-ptd> não é NULL.
STG_E_MEDIUMFULL
 A mídia de armazenamento está cheia.

Comentários

IOleCache::SetData geralmente é chamado quando um objeto é criado a partir da área de transferência ou por meio de uma operação de arrastar e soltar, e Inserir Dados de origem é usado para criar o objeto.

IOleCache::SetData e IOleCache::InitCache são muito semelhantes. Há duas diferenças main. A primeira diferença é que, enquanto IOleCache::InitCache inicializa o cache com o formato de apresentação fornecido pelo objeto de dados, IOleCache::SetData o inicializa com um único formato. Em segundo lugar, o método IOleCache::SetData ignora o sinalizador ADVF_NODATA enquanto IOleCache::InitCache obedece a esse sinalizador.

Um contêiner pode usar esse método para manter um único aspecto de um objeto, como o aspecto de ícone do objeto.

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 oleidl.h

Confira também

IOleCache

IOleCache::Cache

IOleCache::SetData