Функция ScheduleJob

Статья
06/13/2023

Функция ScheduleJob запрашивает, чтобы очередь печати печати планировала указанное задание печати для печати.

Синтаксис

BOOL ScheduleJob(
  _In_ HANDLE hPrinter,
  _In_ DWORD  dwJobID
);

Параметры

hPrinter [in]

Дескриптор принтера для задания печати. Это должен быть локальный принтер, настроенный в качестве распущенного принтера. Если hPrinter является дескриптором подключения к удаленному принтеру или принтер настроен для прямой печати, функция ScheduleJob завершается сбоем . Используйте функцию OpenPrinter или AddPrinter , чтобы получить дескриптор принтера.

hPrinter должен быть тем же дескриптором принтера, который указан в вызове Метода AddJob , который получил идентификатор задания печати dwJobID .

dwJobID [in]

Запланированное задание печати. Этот идентификатор задания печати можно получить путем вызова функции AddJob .

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

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

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

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

Перед вызовом функции ScheduleJob необходимо успешно вызвать функцию AddJob. AddJob получает идентификатор задания печати, который передается в ScheduleJob как dwJobID. Оба вызова должны использовать одно и то же значение для hPrinter.

Функция ScheduleJob проверяет наличие допустимого файла очереди. Если имеется недопустимый файл очереди или если он пуст, ScheduleJob удаляет файл очереди и соответствующую запись задания печати в очереди печати.

Требования

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

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

Вывод на печать
Функции API очереди печати принтера
AddJob
OpenPrinter