Método IOleUndoManager::D iscardFrom (ocidl.h)

  • Artigo

Instrui o gerenciador de desfazer a descartar a unidade de desfazer especificada e todas as unidades de desfazer abaixo dela na pilha desfazer ou refazer.

Sintaxe

HRESULT DiscardFrom(
  [in] IOleUndoUnit *pUU
);

Parâmetros

[in] pUU

Um ponteiro IOleUndoUnit para a unidade de desfazer a ser descartada. Esse parâmetro pode ser NULL para descartar toda a pilha de desfazer ou refazer. Se o parâmetro não for NULL , a pilha não será descartada.

Valor retornado

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

Código de retorno Descrição
E_INVALIDARG
 A unidade de desfazer especificada não foi encontrada nas pilhas.
E_UNEXPECTED
 O gerenciador de desfazer está desabilitado.

Comentários

O gerenciador de desfazer primeiro pesquisa a pilha de desfazer para a unidade fornecida e, se não for encontrado, pesquisa a pilha de refazer. Depois de encontrado, a unidade fornecida e tudo abaixo dela na mesma pilha são descartados. A unidade de desfazer pode ser um filho de uma unidade pai contida pelo gerenciador de desfazer, conforme determinado chamando IOleParentUndoUnit::FindUnit. Se for uma unidade filho, a unidade raiz que contém a unidade especificada e todas as unidades abaixo dela na pilha apropriada serão descartadas.

Se houver uma unidade pai aberta e o método DiscardFrom for chamado e o parâmetro pUU for NULL, o gerenciador de desfazer deverá liberar e descartar imediatamente a unidade pai aberta sem chamar o IOleUndoManager::Close primeiro. Quando o objeto que abriu a unidade pai tentar fechá-lo, IOleUndoManager::Close retornará S_FALSE. Se uma unidade pai estiver aberta, jogue-a fora e descarte a pilha. Se a unidade pai não estiver aberta, basta jogar a pilha fora. Se o parâmetro pUU não for NULL, todas as unidades pai abertas deverão ser deixadas abertas.

Requisitos

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

Confira também

IOleParentUndoUnit::FindUnit

IOleUndoManager

IOleUndoManager::Close