Функция Абортпринтер

Функция абортпринтер удаляет файл очереди принтера, если принтер настроен для работы в очереди.

Синтаксис

BOOL AbortPrinter(
  _In_ HANDLE hPrinter
);

Параметры

хпринтер [ окне]

Обработчик для принтера, с которого удаляется файл очереди. Используйте функцию опенпринтер или аддпринтер для получения маркера принтера.

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

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

Если функция выполняется неудачно, возвращается нулевое значение.

Комментарии

Примечание

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

Если принтер не настроен для работы с очередью, функция абортпринтер не действует.

Последовательность для задания печати выглядит следующим образом:

  1. Чтобы начать задание печати, вызовите стартдокпринтер.
  2. Чтобы начать каждую страницу, вызовите стартпажепринтер.
  3. Чтобы записать данные на страницу, вызовите вритепринтер.
  4. Чтобы завершить каждую страницу, вызовите ендпажепринтер.
  5. Повторите 2, 3 и 4 для требуемого количества страниц.
  6. Чтобы завершить задание печати, вызовите енддокпринтер.

Если страница в буферизованном файле превышает приблизительно 350 МБ, она может не печататься и не отправить сообщение об ошибке. Например, это может произойти при печати больших EMF файлов. Ограничение размера страницы зависит от многих факторов, включая объем доступной виртуальной памяти, объем памяти, выделенной вызывающими процессами, и объем фрагментации в куче процесса.

Требования

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

См. также раздел

Вывод на печать

Функции API очереди печати принтера

енддокпринтер

ендпажепринтер

опенпринтер

стартдокпринтер

стартпажепринтер

вритепринтер