Share via

Função DeletePrinter

  • Artigo

A função DeletePrinter exclui o objeto de impressora especificado.

Sintaxe

BOOL DeletePrinter(
  _Inout_ HANDLE hPrinter
);

Parâmetros

hPrinter [in, out]

Manipule para um objeto de impressora que será excluído. Use a função OpenPrinter ou AddPrinter para recuperar um identificador de impressora.

Valor retornado

Se a função for bem-sucedida, o valor retornado será um valor diferente de zero.

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

Comentários

Observação

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 fatores de implementação do driver de impressora que são difíceis de prever ao gravar 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.

Se ainda houver trabalhos de impressão a serem processados para a impressora especificada, DeletePrinter marcará a impressora para exclusão pendente e a excluirá quando todos os trabalhos de impressão forem impressos. Nenhum trabalho de impressão pode ser adicionado a uma impressora marcada para exclusão pendente.

Uma impressora marcada para exclusão pendente não pode ser mantida, mas seus trabalhos de impressão podem ser mantidos, retomados e reiniciados. Se a impressora for mantida e houver trabalhos para a impressora, DeletePrinter falhará com ERROR_ACCESS_DENIED.

Observe que DeletePrinter não fecha o identificador que é passado para ele. Portanto, o aplicativo ainda deve chamar ClosePrinter.

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]
Cabeçalho
Winspool.h (inclua Windows.h)
Biblioteca
Winspool.lib
DLL
Spoolss.dll

Confira também

Impressão

Funções da API do Spooler de impressão

AddPrinter

EnumPrinters

OpenPrinter