Функция EnumPrintProcessors

Статья
06/12/2023

Функция EnumPrintProcessors перечисляет процессоры печати, установленные на указанном сервере.

Синтаксис

BOOL EnumPrintProcessors(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pEnvironment,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pPrintProcessorInfo,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

Параметры

pName [in]

Указатель на строку, завершающуюся значением NULL, которая указывает имя сервера, на котором находятся процессоры печати. Если этот параметр имеет значение NULL, перечисляются локальные процессоры печати.

pEnvironment [in]

Указатель на строку со значением NULL, которая указывает среду (например, Windows x86, Windows IA64 или Windows x64). Если этот параметр имеет значение NULL, используется текущая среда вызывающего приложения и клиентского компьютера (не конечного приложения и сервера печати).

Level [in]

Тип сведений, возвращаемых в буфере pPrintProcessorInfo . Этот параметр должен иметь значение 1.

pPrintProcessorInfo [out]

Указатель на буфер, получающий массив PRINTPROCESSOR_INFO_1 структур. Каждая структура описывает доступный процессор печати. Буфер должен быть достаточно большим для получения массива структур и строк, на которые указывают члены структуры.

Чтобы определить требуемый размер буфера, вызовите EnumPrintProcessors с параметром cbBuf , равным нулю. EnumPrintProcessors завершается сбоем, GetLastError возвращает ERROR_INSUFFICIENT_BUFFER, а параметр pcbNeeded возвращает размер буфера, необходимого для хранения массива структур и их данных, в байтах.

cbBuf [in]

Размер (в байтах) буфера, на который указывает pPrintProcessorInfo.

pcbNeeded [ out]

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

pcReturned [out]

Указатель на переменную, которая получает количество структур, возвращаемых в буфере pPrintProcessorInfo .

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

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

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

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

Требования

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

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

Вывод на печать
Функции API очереди печати принтера
AddPrintProcessor
EnumPrintProcessorDatatypes
PRINTPROCESSOR_INFO_1

Поделиться через