Функция AddPort

Статья
06/12/2023

Функция AddPort добавляет имя порта в список поддерживаемых портов. Функция AddPort экспортируется монитором портов.

Синтаксис

BOOL AddPort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pMonitorName
);

Параметры

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

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

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

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

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

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

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

Чтобы добавить порт без отображения диалогового окна, вызовите функцию XcvData вместо AddPort. Дополнительные сведения о XcvData см. в пакете средств разработки драйверов Microsoft Windows (DDK).

Требования

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

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

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

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