Функция DeletePrinterDataEx

Статья
06/12/2023

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

Как и функция DeletePrinterData , DeletePrinterDataEx может удалять значения, сохраненные функцией SetPrinterData . Кроме того, DeletePrinterDataEx может удалять значения, хранящиеся в указанном ключе с помощью функции SetPrinterDataEx .

Синтаксис

DWORD DeletePrinterDataEx(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName,
  _In_ LPCTSTR pValueName
);

Параметры

hPrinter [in]

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

pKeyName [in]

Указатель на строку, завершающуюся значением NULL, которая указывает ключ, содержащий удаляемое значение. Используйте символ обратной косой черты ( \ ) в качестве разделителя, чтобы указать путь, имеющий один или несколько подразделов.

Если pKeyName имеет значение NULL или пустую строку, метод DeletePrinterDataEx возвращает ERROR_INVALID_PARAMETER.

pValueName [in]

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

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

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

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

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

Требования

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

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

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

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