Share via

Gdi::AbortDoc_I (Windows Embedded CE 6.0)

  • Article

1/6/2010

This method stops the current print job.

Syntax

static INGDIAPI int WINAPI AbortDoc_I(
  HDC hdc
);

Parameters

  • hdc
    [in] Handle to the device context for the print job.

Return Value

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 is used to start the print job, calling Gdi::AbortDoc_I erases the entire spool job, so the printer receives nothing.

If Print Manager is not used to start the print job, the data might already have been sent to the printer. In this case, the printer driver resets the printer when possible and ends the print job.

Requirements

Header gdi.hpp
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

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