Функция AbortDoc (wingdi.h)

Статья
08/27/2023

Функция AbortDoc останавливает текущее задание печати и удаляет все, что было нарисовано с момента последнего вызова функции StartDoc .

Синтаксис

int AbortDoc(
  [in] HDC hdc
);

Параметры

[in] hdc

Обработка в контексте устройства для задания печати.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение больше нуля.

Если функция завершается сбоем, возвращаемое значение будет SP_ERROR.

Примечание Это блокирующая или синхронная функция, возвращаемая не сразу. Скорость возврата этой функции зависит от факторов времени выполнения, таких как состояние сети, конфигурация сервера печати и реализация драйвера принтера, которые трудно предсказать при написании приложения. Вызов этой функции из потока, который управляет взаимодействием с пользовательским интерфейсом, может привести к тому, что приложение не отвечает.

Приложения должны вызывать функцию AbortDoc , чтобы остановить задание печати в случае ошибки или остановить задание печати после того, как пользователь отменит это задание. Чтобы завершить успешное задание печати, приложение должно вызвать функцию EndDoc .

Если для запуска задания печати использовался диспетчер печати, вызов AbortDoc стирает все задание очереди, чтобы принтер ничего не получал. Если диспетчер печати не использовался для запуска задания печати, возможно, данные уже отправлены на принтер. В этом случае драйвер принтера сбрасывает принтер (по возможности) и завершает задание печати.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	wingdi.h (включая Windows.h)
Библиотека	Gdi32.lib
DLL	Gdi32.dll