AbortDoc

This function stops the current print job.

At a Glance

Header file Wingdi.h
Windows CE versions: 2.0 and later

Syntax

int AbortDoc(HDC handle);

Parameters

hdc

[in] Handle to the device context (DC) for the print job.

Return Values

A value greater than zero indicates success. SP_ERROR indicates failure. To get extended error information, call GetLastError.

Remarks

Applications should call the AbortDoc function to stop a print job if an error occurs, or to stop a print job after the user cancels that job. To end a successful print job, an application should call the EndDoc function.

If Print Manager was used to start the print job, calling AbortDoc erases the entire spool job, so that the printer receives nothing. If Print Manager was not used to start the print job, the data may already have been sent to the printer. In this case, the printer driver resets the printer (when possible) and ends the print job.

See Also

EndDoc, SetAbortProc, StartDoc