Método IOleLink::SetUpdateOptions (oleidl.h)

Artigo
03/05/2024

Especifica com que frequência um objeto vinculado deve atualizar seus dados armazenados em cache.

Sintaxe

HRESULT SetUpdateOptions(
  [in] DWORD dwUpdateOpt
);

Parâmetros

[in] dwUpdateOpt

Especifica com que frequência um objeto vinculado deve atualizar seus dados armazenados em cache. Os valores possíveis para dwUpdateOpt são obtidos da enumeração OLEUPDATE.

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
E_INVALIDARG	O valor fornecido é inválido.

Comentários

Anotações aos Chamadores

Seu aplicativo de contêiner deve chamar IOleLink::SetUpdateOptions quando o usuário final alterar a opção de atualização de um objeto vinculado.

O usuário final seleciona a opção de atualização para um objeto vinculado usando a caixa de diálogo Links . Se você usar a função OleUIEditLinks para exibir essa caixa de diálogo, deverá implementar a interface IOleUILinkContainer . A caixa de diálogo chama o método IOleUILinkContainer::SetLinkUpdateOptions para especificar a opção de atualização escolhida pelo usuário final. Sua implementação desse método deve chamar o método IOleLink::SetUpdateOptions para passar a opção selecionada para o objeto vinculado.

Observações aos implementadores

A opção de atualização padrão é OLEUDPATE_ALWAYS. A implementação do objeto vinculado de IPersistStorage::Save salva a opção de atualização atual.

Se OLEUDPATE_ALWAYS for especificado como a opção de atualização, o objeto vinculado atualizará os caches do link nas seguintes situações:

Quando a opção de atualização é alterada de manual para automática, se a origem do link estiver em execução.
Sempre que o objeto vinculado é associado à origem do link.
Sempre que a origem do link estiver em execução e as implementações IOleObject::Close, IPersistStorage::Save ou IAdviseSink::OnSave do objeto vinculado forem chamadas.

Para links manuais e automáticos, o objeto vinculado atualiza o cache sempre que o aplicativo de contêiner chama IOleObject::Update ou IOleLink::Update.

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