Share via

Gdi::AbortDoc_I

  • Article

This method stops the current print job.

static INGDIAPI int WINAPI AbortDoc_I(
  HDC hdc
);

Parameters

  • hdc
    [in] Handle to the device context 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

This method is an internal version of the AbortDoc function.

Applications should call the Gdi::AbortDoc_I method 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 Gdi::EndDoc_I method.

If Print Manager was used to start the print job, calling Gdi::AbortDoc_I 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.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

AbortDoc | Gdi::EndDoc_I | Gdi::SetAbortProc_I | Gdi::StartDocW_I

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.