getUdpTable 函数 (iphlpapi.h)

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 Vista 及更高版本发布的 Windows SDK 上，此参数的数据类型将更改为等效于 PDWORD 的 PULONG。

[in] Order

一个布尔值，指定是否应对返回的 UDP 侦听器表进行排序。如果此参数为 TRUE，则按以下顺序对表进行排序：

如果函数成功，则返回值NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

返回代码	说明
ERROR_INSUFFICIENT_BUFFER	pUdpTable 参数指向的缓冲区不够大。所需大小在 pdwSize 参数指向的 ULONG 变量中返回。如果 pUdpTable 参数为 NULL，也会返回此错误。
ERROR_INVALID_PARAMETER	pdwSize 参数为 NULL，或者 GetUdpTable 无法写入 pdwSize 参数指向的内存。
ERROR_NOT_SUPPORTED	本地系统上正在使用的操作系统不支持此函数。
其他	使用 FormatMessage 获取返回错误的消息字符串。

在针对 Windows Vista 及更高版本发布的 Windows SDK 上，GetUdpTable 函数的返回值将更改为与 DWORD 等效的 ULONG 数据类型。