Функция DeletePort

Статья
06/12/2023

Функция DeletePort отображает диалоговое окно, позволяющее пользователю удалить имя порта.

Синтаксис

BOOL DeletePort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pPortName
);

Параметры

pName [in]: Указатель на строку с нулем, которая указывает имя сервера, для которого необходимо удалить порт. Если этот параметр имеет значение NULL, локальный порт удаляется.
hWnd [in]: Дескриптор родительского окна диалогового окна удаления портов.
pPortName [in]: Указатель на строку с нулем, указывающую имя порта, который следует удалить.

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

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

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

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

Приложение может получить имена допустимых портов, вызвав функцию EnumPorts .

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

Вызывающий объект функции DeletePort должен иметь SERVER_ACCESS_ADMINISTER доступ к серверу, к которому подключен порт.

Требования

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

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

Вывод на печать
Функции API очереди печати принтера
AddPort
EnumPorts

Share via