Функция DeletePrinterData

Статья
06/12/2023

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

Вызов DeletePrinterData эквивалентен вызову функции DeletePrinterDataEx с параметром pKeyName , равным "PrinterDriverData".

Синтаксис

DWORD DeletePrinterData(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pValueName
);

Параметры

hPrinter [in]: Дескриптор принтера, данные конфигурации которого необходимо удалить. Используйте функцию OpenPrinter или AddPrinter , чтобы получить дескриптор принтера.
pValueName [in]: Указатель на имя удаляемого значения данных конфигурации, завершающееся значением NULL.

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

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

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

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

Требования

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

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

Вывод на печать
Функции API очереди печати принтера
EnumPrinterData
GetPrinterData
OpenPrinter
SetPrinter
SetPrinterData