Функция DeletePrinterKey

Статья
06/12/2023

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

Синтаксис

DWORD DeletePrinterKey(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName
);

Параметры

hPrinter [in]

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

pKeyName [in]

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

Если pKeyName является пустой строкой (""), DeletePrinterKey удаляет все ключи под ключом верхнего уровня для принтера. Если pKeyName имеет значение NULL, функция DeletePrinterKey возвращает ERROR_INVALID_PARAMETER.

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

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

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

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

Требования

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

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

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

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