Функция SetPrinterData

Статья
06/13/2023

Функция SetPrinterData задает данные конфигурации для принтера или сервера печати.

Чтобы указать раздел реестра, в котором будут храниться данные, вызовите функцию SetPrinterDataEx . Вызов SetPrinterData эквивалентен вызову функции SetPrinterDataEx с параметром pKeyName , равным PrinterDriverData.

Синтаксис

DWORD SetPrinterData(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pValueName,
  _In_ DWORD  Type,
  _In_ LPBYTE pData,
  _In_ DWORD  cbData
);

Параметры

hPrinter [in]

Дескриптор принтера или сервера печати, для которого функция задает данные конфигурации. Используйте функцию OpenPrinter, OpenPrinter2 или AddPrinter для получения дескриптора принтера.

pValueName [in]

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

Для принтеров эта строка представляет собой имя значения реестра в разделе PrinterDriverData принтера в реестре.

Для серверов печати эта строка является одной из предопределенных строк, перечисленных в следующем разделе Примечаний.

Введите [in]

Код, указывающий тип данных, на который указывает параметр pData . Список возможных кодов типов см. в разделе Типы значений реестра.

pData [in]

Указатель на массив байтов, содержащий данные конфигурации принтера.

cbData [in]

Размер массива в байтах.

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

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

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

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

Чтобы получить существующие данные конфигурации для принтера, вызовите функцию GetPrinterDataEx или GetPrinterData .

Если hPrinter является дескриптором сервера печати, pValueName может указать одно из следующих предопределенных значений.

Значение	Комментарии
SPLREG_ALLOW_USER_MANAGEFORMS	Windows XP с пакетом обновления 2 (SP2) и более поздних версий Windows Server 2003 с пакетом обновления 1 (SP1) и более поздних версий
SPLREG_BEEP_ENABLED
SPLREG_DEFAULT_SPOOL_DIRECTORY
SPLREG_EVENT_LOG
SPLREG_NET_POPUP	Не поддерживается в Windows Server 2003 и более поздних версиях
SPLREG_PORT_THREAD_PRIORITY_DEFAULT
SPLREG_PORT_THREAD_PRIORITY
SPLREG_PRINT_DRIVER_ISOLATION_GROUPS	Windows 7 и более поздние версии
SPLREG_PRINT_DRIVER_ISOLATION_TIME_BEFORE_RECYCLE	Windows 7 и более поздние версии
SPLREG_PRINT_DRIVER_ISOLATION_MAX_OBJECTS_BEFORE_RECYCLE	Windows 7 и более поздние версии
SPLREG_PRINT_DRIVER_ISOLATION_IDLE_TIMEOUT	Windows 7 и более поздние версии
SPLREG_PRINT_DRIVER_ISOLATION_EXECUTION_POLICY	Windows 7 и более поздние версии
SPLREG_PRINT_DRIVER_ISOLATION_OVERRIDE_POLICY	Windows 7 и более поздние версии
SPLREG_RETRY_POPUP	При успешном возвращении pData содержит 1, если сервер настроен на повторную попытку всплывающих окон для всех заданий, или 0, если сервер не повторяет всплывающие окна для всех заданий. Не поддерживается в Windows Server 2003 и более поздних версиях
SPLREG_SCHEDULER_THREAD_PRIORITY
SPLREG_SCHEDULER_THREAD_PRIORITY_DEFAULT
SPLREG_WEBSHAREMGMT	Windows Server 2003 и более поздние версии

Следующие значения pValueName определяют поведение печати пула при возникновении ошибки.

Значение	Комментарии
SPLREG_RESTART_JOB_ON_POOL_ERROR	Значение pData указывает время (в секундах) перезапуска задания на другом порту после возникновения ошибки. Этот параметр используется с SPLREG_RESTART_JOB_ON_POOL_ENABLED.
SPLREG_RESTART_JOB_ON_POOL_ENABLED	Ненулевое значение в pData указывает, что SPLREG_RESTART_JOB_ON_POOL_ERROR включен.

Время, указанное в SPLREG_RESTART_JOB_ON_POOL_ERROR , — это минимальное время. Фактическое время может быть больше в зависимости от следующих параметров монитора портов, которые являются значениями реестра в этом разделе реестра:

HKLM\SYSTEM\CurrentControlSet\Control\Print\Monitors\<MonitorName>\Ports

Вызовите функцию RegSetValueEx , чтобы задать эти значения.

Параметр монитора портов	Тип данных	Значение
StatusUpdateEnabled	REG_DWORD	Если значение не равно нулю, монитор портов может обновить очередь очереди, указав состояние порта.
StatusUpdateInterval	REG_DWORD	Указывает интервал в минутах, когда монитор портов обновляет очередь очереди с состоянием порта.

В Windows 7 и более поздних версиях Windows задания печати, отправляемые на сервер печати, по умолчанию отрисовываются на клиенте. Отрисовку заданий печати на стороне клиента можно настроить для каждого принтера, задав следующие значения в pValueName.

Параметр	Тип данных	Описание
EMFDespoolingSetting	REG_DWORD	Значение 0 или, если это значение отсутствует в реестре, включает отрисовку заданий печати на стороне клиента по умолчанию. Значение 1 отключает отрисовку заданий печати на стороне клиента.
ForceClientSideRendering	REG_DWORD	Значение 0 или, если это значение отсутствует в реестре, приводит к отображению заданий печати на клиенте. Если задание печати не удается отобразить на клиенте, оно будет отрисовывается на сервере. Если задание печати не может быть отрисовывается на сервере, оно завершится ошибкой. Значение 1 будет отображать задания печати на клиенте. Если задание печати не удается отобразить на клиенте, оно завершится ошибкой.

Требования

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

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

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