The AbortDoc function stops the current print job and erases everything drawn since the last call to the StartDoc function. This function replaces the ABORTDOC printer escape.
int AbortDoc(
| HDC hdc | // handle to device context |
| ); |
Parameters
hdc
Identifies the device context for the print job.
Return Values
If the function succeeds, the return value is greater than zero.
If the function fails, the return value is SP_ERROR. 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 Windows 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