Функции API очереди печати принтера
API очереди печати содержит функции и структуры данных, используемые приложениями для управления очередью печати Windows, а также принтерами и заданиями печати, которыми он управляет.
Функции API очереди печати делятся на следующие группы:
- Функции задания печати
- Функции пользовательского интерфейса принтера
- Функции принтера
- Функции уведомления об изменении принтера
- Функции формы принтера
- Функции очереди печати
Функции задания печати
Эти функции отправляют задания печати на принтер, а также отслеживают задания печати и управляют ими в очереди печати.
Функция | Описание |
---|---|
AddJob |
Функция AddJob добавляет задание печати в список заданий печати, которые могут быть запланированы диспетчером очереди печати. Функция извлекает имя файла, который можно использовать для хранения задания. |
ClosePrinter |
Функция ClosePrinter закрывает указанный объект принтера. |
DocumentEvent |
Функция DocumentEvent — это обработчик событий, связанных с печатью документа. |
DocumentProperties |
Функция DocumentProperties извлекает или изменяет сведения об инициализации принтера или отображает страницу свойств конфигурации принтера для указанного принтера. |
EndDocPrinter |
Функция EndDocPrinter завершает задание печати для указанного принтера. |
EndPagePrinter |
Функция EndPagePrinter уведомляет диспетчер очереди печати о том, что приложение находится в конце страницы в задании печати. |
Задания перечисления |
Функция EnumJobs извлекает сведения об указанном наборе заданий печати для указанного принтера. |
GetJob |
Функция GetJob извлекает сведения об указанном задании печати. |
OpenPrinter |
Функция OpenPrinter извлекает дескриптор указанного принтера или сервера печати или других типов дескрипторов в подсистеме печати. |
OpenPrinter2 |
Извлекает дескриптор указанного принтера, сервера печати или других типов дескрипторов в подсистеме печати, задавая при этом некоторые параметры принтера. |
ReportJobProcessingProgress |
Сообщает службе очереди печати печати, указывает, находится ли задание печати XPS на этапе spooling или подготовки к просмотру и какая часть обработки выполняется в данный момент. |
ScheduleJob |
Функция ScheduleJob запрашивает, чтобы очередь печати запланировыла указанное задание печати для печати. |
SetJob |
Функция SetJob приостанавливает, возобновляет, отменяет или перезапускает задание печати на указанном принтере. Вы также можете использовать функцию SetJob для задания параметров задания печати, таких как приоритет задания печати и имя документа. |
StartDocPrinter |
Функция StartDocPrinter уведомляет диспетчер очереди печати о том, что документ должен быть распечатыван для печати. |
StartPagePrinter |
Функция StartPagePrinter уведомляет диспетчер очереди о том, что страница будет напечатана на указанном принтере. |
Функции пользовательского интерфейса принтера
Эти функции отображают пользовательский интерфейс, позволяющий пользователю выбрать или настроить принтер.
Функция | Описание |
---|---|
AdvancedDocumentProperties |
Функция AdvancedDocumentProperties отображает диалоговое окно конфигурации принтера для указанного принтера, позволяющее пользователю настроить этот принтер. |
Настройка порта |
Функция ConfigurePort отображает диалоговое окно настройки порта для порта на указанном сервере. |
ConnectToPrinterDlg |
Функция ConnectToPrinterDlg отображает диалоговое окно, позволяющее пользователям просматривать принтеры в сети и подключаться к нему. Если пользователь выбирает принтер, функция пытается создать к нему подключение; Если подходящий драйвер не установлен на сервере, пользователю предоставляется возможность локального создания принтера. |
Свойства PrinterProperties |
Функция PrinterProperties отображает страницу свойств принтера для указанного принтера. |
Функции принтера
Эти функции добавляют и настраивают принтеры, используемые диспетчером очереди печати.
Функция | Описание |
---|---|
AbortPrinter |
Функция AbortPrinter удаляет файл очереди принтера, если принтер настроен для очереди. |
AddPrinter |
Функция AddPrinter добавляет принтер в список поддерживаемых принтеров для указанного сервера. |
AddPrinterConnection |
Функция AddPrinterConnection добавляет подключение к указанному принтеру для текущего пользователя. |
AddPrinterConnection2 |
Добавляет подключение к указанному принтеру для текущего пользователя и указывает сведения о подключении. |
DeletePrinter |
Функция DeletePrinter удаляет указанный объект принтера. |
DeletePrinterConnection |
Функция DeletePrinterConnection удаляет подключение к принтеру, которое было установлено путем вызова Метода AddPrinterConnection или ConnectToPrinterDlg. |
DeletePrinterData |
Функция DeletePrinterData удаляет указанные данные конфигурации для принтера. Данные конфигурации принтера состоят из набора именованных и типизированных значений. Функция DeletePrinterData удаляет одно из этих значений, указанное именем значения. |
DeletePrinterDataEx |
Функция DeletePrinterDataEx удаляет указанное значение из данных конфигурации принтера. Данные конфигурации принтера состоят из набора именованных и типизированных значений, хранящихся в иерархии разделов реестра. Функция удаляет указанное значение в указанном ключе. |
DeletePrinterKey |
Функция DeletePrinterKey удаляет указанный ключ и все его подразделы для указанного принтера. |
EnumPrinterData |
Функция EnumPrinterData перечисляет данные конфигурации для указанного принтера. |
EnumPrinterDataEx |
Функция EnumPrinterDataEx перечисляет все имена значений и данные для указанного принтера и ключа. |
EnumPrinterKey |
Функция EnumPrinterKey перечисляет подразделы указанного ключа для указанного принтера. |
EnumPrinters |
Функция EnumPrinters перечисляет доступные принтеры, серверы печати, домены или поставщики печати. |
FlushPrinter |
Функция FlushPrinter отправляет буфер принтеру, чтобы очистить его от временного состояния. |
GetDefaultPrinter |
Функция GetDefaultPrinter извлекает имя принтера по умолчанию для текущего пользователя на локальном компьютере. |
GetPrinter |
Функция GetPrinter извлекает сведения об указанном принтере. |
GetPrinterData |
Функция GetPrinterData извлекает данные конфигурации для указанного принтера или сервера печати. |
GetPrinterDataEx |
Функция GetPrinterDataEx извлекает данные конфигурации для указанного принтера или сервера печати.
GetPrinterDataEx может извлекать значения, хранящиеся функцией SetPrinterData . Кроме того, GetPrinterDataEx может извлекать значения, хранящиеся в указанном ключе с помощью функции SetPrinterDataEx . |
IsValidDevmode |
Функция IsValidDevmode проверяет допустимость содержимого структуры DEVMODE. |
ReadPrinter |
Функция ReadPrinter извлекает данные из указанного принтера. |
ResetPrinter |
Функция ResetPrinter указывает тип данных и значения режима устройства, которые будут использоваться для печати документов, отправленных функцией StartDocPrinter . Эти значения можно переопределить с помощью функции SetJob после начала печати документов. |
SetDefaultPrinter |
Функция SetDefaultPrinter задает имя принтера по умолчанию для текущего пользователя на локальном компьютере. |
SetPort |
Функция SetPort задает состояние, связанное с портом принтера. |
SetPrinter |
Функция SetPrinter задает данные для указанного принтера или задает состояние указанного принтера путем приостановки печати, возобновления печати или очистки всех заданий печати. |
SetPrinterData |
Функция SetPrinterData задает данные конфигурации для принтера или сервера печати. |
SetPrinterDataEx |
Функция SetPrinterDataEx задает данные конфигурации для принтера или сервера печати. Функция сохраняет данные конфигурации в разделе реестра принтера. |
WritePrinter |
Функция WritePrinter уведомляет диспетчер очереди печати печати о том, что данные должны быть записаны на указанный принтер. |
Функции уведомления об изменении принтера
Эти функции позволяют приложению получать уведомления об изменениях в состоянии принтера.
Функция | Описание |
---|---|
FindClosePrinterChangeNotification |
Функция FindClosePrinterChangeNotification закрывает объект уведомления об изменениях, созданный путем вызова функции FindFirstPrinterChangeNotification . Принтер или сервер печати, связанные с объектом уведомления об изменениях, больше не будут отслеживаться этим объектом. |
FindFirstPrinterChangeNotification |
Функция FindFirstPrinterChangeNotification создает объект уведомления об изменениях и возвращает дескриптор объекту . Затем этот дескриптор можно использовать в вызове одной из функций ожидания для отслеживания изменений на принтере или сервере печати. |
FindNextPrinterChangeNotification |
Функция FindNextPrinterChangeNotification извлекает сведения о последнем уведомлении об изменениях для объекта уведомления об изменениях, связанного с принтером или сервером печати. Вызывайте эту функцию, когда выполняется операция ожидания объекта уведомления об изменениях. |
FreePrinterNotifyInfo |
Функция FreePrinterNotifyInfo освобождает буфер, выделенный системой, созданный функцией FindNextPrinterChangeNotification . |
Функции формы принтера
Эти функции управляют формами, используемыми принтером.
Функция | Описание |
---|---|
AddForm |
Функция AddForm добавляет форму в список доступных форм, которые можно выбрать для указанного принтера. |
DeleteForm |
Функция DeleteForm удаляет имя формы из списка поддерживаемых форм. |
EnumForms |
Функция EnumForms перечисляет формы, поддерживаемые указанным принтером. |
GetForm |
Функция GetForm извлекает сведения об указанной форме. |
SetForm |
Функция SetForm задает сведения о форме для указанного принтера. |
Печать функций очереди очереди печати
Эти функции взаимодействуют с очередью печати печати на низком уровне.
Функция | Описание |
---|---|
CloseSpoolFileHandle |
Функция CloseSpoolFileHandle закрывает дескриптор в файл очереди, связанный с заданием печати, отправленным приложением. |
CommitSpoolData |
Функция CommitSpoolData уведомляет диспетчер очереди печати печати о том, что указанный объем данных был записан в указанный файл очереди и готов к просмотру. |
GetPrintExecutionData |
GetPrintExecutionData извлекает текущий контекст печати. |
GetSpoolFileHandle |
Функция GetSpoolFileHandle извлекает дескриптор для файла очереди, связанного с заданием, которое в настоящее время отправлено приложением. |