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

Статья
08/24/2023

Функция GetUdpTable извлекает таблицу прослушивателя протокола UDP IPv4.

Синтаксис

IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
  [out]     PMIB_UDPTABLE UdpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

Параметры

[out] UdpTable

Указатель на буфер, который получает таблицу прослушивателя IPv4 UDP в виде структуры MIB_UDPTABLE .

[in, out] SizePointer

На входных данных указывает размер буфера в байтах, на который указывает параметр UdpTable .

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

В windows SDK, выпущенном для Windows Vista и более поздних версий, тип данных для этого параметра изменяется на PULONG , что эквивалентно PDWORD.

[in] Order

Логическое значение, указывающее, следует ли отсортировать возвращаемую таблицу прослушивателя UDP. Если этот параметр имеет значение TRUE, таблица сортируется в следующем порядке:

Локальный IP-адрес
Локальный порт

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

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

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

Код возврата	Описание
ERROR_INSUFFICIENT_BUFFER	Буфер, на который указывает параметр pUdpTable, недостаточно велик. Требуемый размер возвращается в переменной ULONG , на которую указывает параметр pdwSize . Эта ошибка также возвращается, если параметр pUdpTable имеет значение NULL.
ERROR_INVALID_PARAMETER	Параметр pdwSize имеет значение NULL, или GetUdpTable не может выполнить запись в память, на которую указывает параметр pdwSize .
ERROR_NOT_SUPPORTED	Эта функция не поддерживается в операционной системе, используемой в локальной системе.
Другое	Используйте FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки.

Требования


Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	iphlpapi.h
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll