Функция LookupPersistentUdpPortReservation (iphlpapi.h)

Статья
08/24/2023

Функция LookupPersistentUdpPortReservation ищет маркер для постоянного резервирования портов UDP для последовательного блока TCP-портов на локальном компьютере.

Синтаксис

IPHLPAPI_DLL_LINKAGE ULONG LookupPersistentUdpPortReservation(
  [in]  USHORT   StartPort,
  [in]  USHORT   NumberOfPorts,
  [out] PULONG64 Token
);

Параметры

[in] StartPort

Начальный номер порта UDP в порядке сетевых байтов.

[in] NumberOfPorts

Количество зарезервированных портов UDP.

[out] Token

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

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

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

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

Код возврата	Описание
ERROR_INVALID_PARAMETER	В функцию передан недопустимый параметр. Эта ошибка возвращается, если в параметрах StartPort или NumberOfPorts передается ноль.
ERROR_NOT_FOUND	Элемент не обнаружен. Эта ошибка возвращается, если не удалось найти постоянный блок портов, указанный параметрами StartPort и NumberOfPorts .
Другое	Используйте FormatMessage , чтобы получить строку сообщения для возвращенной ошибки.

Постоянное резервирование для блока портов UDP создается путем вызова функции CreatePersistentUdpPortReservation . Параметры StartPort или NumberOfPorts, передаваемые функции LookupPersistentUdpPortReservation , должны соответствовать значениям, используемым при создании постоянного резервирования для блока TCP-портов функцией CreatePersistentUdpPortReservation .

Если функция LookupPersistentUdpPortReservation выполнена успешно, возвращаемый параметр Token будет указывать на маркер для постоянного резервирования портов для блока портов UDP. Обратите внимание, что маркер для заданного постоянного резервирования для блока TCP-портов может изменяться при каждом перезапуске системы.

Приложение может запросить назначения портов из резервирования портов UDP, открыв сокет UDP, а затем вызвав функцию WSAIoctl , указав SIO_ASSOCIATE_PORT_RESERVATION IOCTL и передав маркер резервирования перед вызовом функции bind в сокете.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	iphlpapi.h
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll