Функция ConfigurePort

Статья
06/12/2023

Функция ConfigurePort отображает диалоговое окно настройки порта для порта на указанном сервере.

Синтаксис

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

Параметры

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

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

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

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

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

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

Требования

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

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

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