DeletePrinter

The DeletePrinter function deletes the specified printer object.

BOOL DeletePrinter(
  HANDLE hPrinter   // handle to printer object
);

Parameters

hPrinter

[in/out] Handle to a printer object that will be deleted. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.

Return Values

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If there are print jobs remaining to be processed for the specified printer, DeletePrinter marks the printer for pending deletion, and then deletes it when all the print jobs have been printed. No print jobs can be added to a printer that is marked for pending deletion.

A printer marked for pending deletion cannot be held, but its print jobs can be held, resumed, and restarted. If the printer is held and there are jobs for the printer, DeletePrinter fails with an InvalidState error.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Winspool.h; include Windows.h.
  Library: Use Winspool.lib.

See Also

Printing and Print Spooler Overview, Printing and Print Spooler Functions, AddPrinter, EnumPrinters, OpenPrinter