Função AbortDoc (wingdi.h)

Artigo
03/13/2024

A função AbortDoc interrompe o trabalho de impressão atual e apaga tudo desenhado desde a última chamada para a função StartDoc .

Sintaxe

int AbortDoc(
  [in] HDC hdc
);

Parâmetros

[in] hdc

Manipule para o contexto do dispositivo para o trabalho de impressão.

Retornar valor

Se a função obtiver êxito, o valor retornado será maior que zero.

Se a função falhar, o valor retornado será SP_ERROR.

Comentários

Nota Essa é uma função de bloqueio ou síncrona e pode não retornar imediatamente. A rapidez com que essa função retorna depende de fatores de tempo de execução, como status de rede, configuração do servidor de impressão e implementação do driver de impressora— fatores difíceis de prever ao escrever um aplicativo. Chamar essa função de um thread que gerencia a interação com a interface do usuário pode fazer com que o aplicativo pareça não responder.

Os aplicativos devem chamar a função AbortDoc para interromper um trabalho de impressão se ocorrer um erro ou interromper um trabalho de impressão depois que o usuário cancelar esse trabalho. Para encerrar um trabalho de impressão bem-sucedido, um aplicativo deve chamar a função EndDoc .

Se o Gerenciador de Impressão foi usado para iniciar o trabalho de impressão, chamar AbortDoc apagará todo o trabalho de spool para que a impressora não receba nada. Se o Gerenciador de Impressão não foi usado para iniciar o trabalho de impressão, os dados podem já ter sido enviados para a impressora. Nesse caso, o driver da impressora redefine a impressora (quando possível) e encerra o trabalho de impressão.

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	wingdi.h (inclua Windows.h)
Biblioteca	Gdi32.lib
DLL	Gdi32.dll