DeletePrinter
The DeletePrinter
function deletes the specified printer object.
BOOL DeletePrinter(
HANDLE hPrinter |
// handle to
printer object |
); |
|
Parameters
hPrinter
Identifies a
printer object that will be deleted.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError
Remarks
The printer
handle hPrinter is obtained by calling the OpenPrinter or AddPrinter
function. Most users will use OpenPrinter.
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.
See Also