Compartilhar via

Método IWriteEngine2::CancelWrite (imapi2.h)

Cancela uma operação de gravação em andamento.

Sintaxe

HRESULT CancelWrite();

Retornar valor

Os seguintes valores são retornados com êxito, mas outros códigos de êxito podem ser retornados como resultado da implementação: Os seguintes códigos de erro normalmente são retornados em caso de falha de operação, mas não representam os únicos valores de erro possíveis:

Código de retorno Descrição
S_OK
 O método foi bem-sucedido.
S_IMAPI_WRITE_NOT_IN_PROGRESS
 A operação 'write' iniciada pela última chamada para IWriteEngine2::WriteSection ainda não foi iniciada e não pode ser cancelada. É recomendável chamar IWriteEngine2::CancelWrite até que um código de sucesso diferente seja retornado.

Valor: 0x00AA0302L
 

Os seguintes códigos de erro geralmente são retornados em caso de falha na operação, mas não representam os únicos valores de erro possíveis:

Código de retorno Descrição
E_FAIL
 Falha não especificada.

Valor: 0x80004005

Comentários

Para cancelar a operação de gravação, você deve chamar esse método do manipulador de eventos DWriteEngine2Events::Update implementado.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista, Windows XP com SP2 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho imapi2.h

Confira também

DWriteEngine2Events

IWriteEngine2

IWriteEngine2::WriteSection

IWriteEngine2::get_WriteInProgress

  • Last updated on